forked from qt-creator/qt-creator
Doc: Generalize info about sharing project settings
...to apply also to CMake projects Change-Id: I5e42c15c273724c04ec9474a85cc36df8fb3069a Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2018 The Qt Company Ltd.
|
** Copyright (C) 2020 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Creator documentation.
|
** This file is part of the Qt Creator documentation.
|
||||||
@@ -36,25 +36,25 @@
|
|||||||
|
|
||||||
\title Sharing Project Settings
|
\title Sharing Project Settings
|
||||||
|
|
||||||
\QC stores user-specific project settings in a .pro.user file. You can
|
\QC stores user-specific project settings in a \e {.user} file. You can
|
||||||
share these settings between several projects as a .pro.shared file. It
|
share these settings between several projects as a \e {.shared} file. It
|
||||||
has the same XML structure as a .pro.user file, but only contains the
|
has the same XML structure as a \e {.user} file, but only contains the
|
||||||
settings to share.
|
settings to share.
|
||||||
|
|
||||||
\section1 Creating Shared Settings File
|
\section1 Creating Shared Settings File
|
||||||
|
|
||||||
The easiest way to create a .pro.shared file is to copy settings from the
|
The easiest way to create a \e {.shared} file is to copy settings from the
|
||||||
.pro.user file. Typically, you would share some of the values in the
|
\e {.user} file. Typically, you would share some of the values in the
|
||||||
\c ProjectExplorer.Project.EditorSettings section.
|
\c ProjectExplorer.Project.EditorSettings section.
|
||||||
|
|
||||||
\note You must always specify the
|
\note You must always specify the
|
||||||
\c ProjectExplorer.Project.Updater.FileVersion variable and use the same
|
\c ProjectExplorer.Project.Updater.FileVersion variable and use the same
|
||||||
value for it as in the .pro.user file.
|
value for it as in the \e {.user} file.
|
||||||
|
|
||||||
You can then deliver the .pro.shared file to other developers or copy it to
|
You can then deliver the \e {.shared} file to other developers or copy it to
|
||||||
other development PCs.
|
other development PCs.
|
||||||
|
|
||||||
The following is an example of a pro.shared file:
|
The following is an example of a \e {.shared} file:
|
||||||
|
|
||||||
\code
|
\code
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
@@ -78,16 +78,16 @@
|
|||||||
|
|
||||||
\section1 Updating Shared Settings
|
\section1 Updating Shared Settings
|
||||||
|
|
||||||
The first time \QC loads the project after you added pro.shared settings,
|
The first time \QC loads the project after you add shared settings,
|
||||||
it overwrites the pro.user settings with them. If you open the project for
|
it overwrites the user settings with them. If you open the project for
|
||||||
the first time and \QC has not created a .pro.user file, the settings in the
|
the first time and \QC has not created a \e {.user} file, the settings
|
||||||
.pro.shared file take effect immediately.
|
in the \e {.shared} file take effect immediately.
|
||||||
|
|
||||||
If you receive a .pro.shared file and do not want to use a particular
|
If you receive a \e {.shared} file and do not want to use a particular
|
||||||
setting in it, you can change it. \QC marks it a \e sticky setting. The next
|
setting in it, you can change it. \QC marks it a \e sticky setting. The next
|
||||||
time you open a project, the setting is not updated. \QC tracks sticky
|
time you open a project, the setting is not updated. \QC tracks sticky
|
||||||
settings in the .pro.user file and removes the mark if the values in the
|
settings in the \e {.user} file and removes the mark if the values in the
|
||||||
pro.user and pro.shared files eventually become identical. This is to avoid
|
user and shared files eventually become identical. This is to avoid
|
||||||
a permanent sticky setting that was created just because you wanted to try
|
a permanent sticky setting that was created just because you wanted to try
|
||||||
something out.
|
something out.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user