aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
blob: f84aef760de34b37539c940c34722dd0feb89e33 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/

// **********************************************************************
// 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.
// **********************************************************************

/*!
    \contentspage index.html
    \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 options, 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.

    \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 Tools >
    \uicontrol Options > \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 Tools > \uicontrol Options >
    \uicontrol {Version Control} > \uicontrol Perforce, and then deselect the
    \uicontrol {Prompt on submit} check box.
*/