aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
blob: a7f24e0484fa18496fe6acee30e66dcf4ce96ef4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
    \previouspage creator-vcs-mercurial.html
    \page creator-vcs-perforce.html
    \nextpage creator-vcs-subversion.html

    \title Using Perforce

    Perforce is a fast software configuration management system developed by
    Perforce Software.

    Since \QC 4.9, the Perforce plugin is disabled by default. To enable
    it, select \uicontrol Help > \uicontrol {About Plugins} >
    \uicontrol {Version Control} > \uicontrol Perforce. Then select
    \uicontrol {Restart Now} to restart \QC and load the plugin.

    \section1 Configuring Perforce

    In the Perforce preferences, you can specify workspace details:
    \uicontrol {P4 user}, \uicontrol {P4 client}, and \uicontrol {P4 port}. To
    specify the details individually for several projects, use configuration
    files instead. Create a \c {p4config.txt} configuration file for each
    project in the top level project directory, and run
    \c{p4 set P4CONFIG=p4config.txt} once. Note that
    \uicontrol {Environment Variables} must be unchecked.

    \section1 Editing Files

    In addition to the standard version control system functions described in
    \l {Using Common Functions}, you can select \uicontrol Tools >
    \uicontrol Perforce > \uicontrol {Edit File} to open a file for editing
    within the client workspace. By default, files are automatically opened for
    editing. To disable this feature, select \uicontrol Edit >
    \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Perforce,
    and then deselect the \uicontrol {Automatically open files when editing}
    check box.

    To list files that are open for editing, select \uicontrol Tools >
    \uicontrol Perforce > \uicontrol Opened.

    To group files for commit, select \uicontrol Tools > \uicontrol Perforce >
    \uicontrol {Pending Changes}.

    To view information about changelists and the files in them, select
    \uicontrol Tools > \uicontrol Perforce > \uicontrol Describe.

    By default, you are prompted to confirm that you want to submit changes.
    To suppress the prompt, select \uicontrol Edit > \uicontrol Preferences >
    \uicontrol {Version Control} > \uicontrol Perforce, and then deselect the
    \uicontrol {Prompt on submit} check box.
*/