diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 12086045ec2..8ceca676da4 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -777,37 +777,42 @@ \section2 Common options - The \gui{Version Control/Common} settings page features common settings for - version control systems, such as commit message line wrapping and checking options. - - \gui{Submit message checking script} is a script or program that can be used to - perform checks on the submit message before submitting. It is passed the - submit message as first parameter. On error, it should output a message on standard error and - return an exit code different from 0. + The \gui{Version Control/Common} settings page features common settings for + version control systems, such as commit message line wrapping and checking + options. - \gui{User/alias configuration file} takes a file in a mailmap format that lists - user names and aliases: + \gui{Submit message checking script} is a script or program that can be + used to perform checks on the submit message before submitting. The submit + message is passed in as the script's first parameter. If there is an error, + the script should output a message on standard error and return a non-zero + exit code. + + \gui{User/alias configuration file} takes a file in mailmap format that + lists user names and aliases. For example: \code Jon Doe Hans Mustermann hm \endcode - The second line specifies that the alias \e{hm} and the corresponding email address should - be used for \e{Hans Mustermann}. If the file is present, the submit editor will feature - a context menu option \gui{Insert name...} that will pop up a dialog letting the user - choose a name to be inserted. + Notice that the second line specifies the alias \e{hm} and the + corresponding email address for \e{Hans Mustermann}. If the user/alias + configuration file is present, the submit editor will display a context + menu with \gui{Insert name...} that will pop up a dialog letting the user + select a name. - \gui{User field configuration file} is a simple text file consisting of lines specifying submit message fields that take user names, for example: + \gui{User field configuration file} is a simple text file consisting of + lines specifying submit message fields that take user names, for example: \code Reviewed-by: Signed-off-by: \endcode - The fields will appear below the submit message. They provide completion on the - aliases/public user names specified in the \e{User/alias configuration file} and an additional - button that opens the aforementioned user name dialog. + These fields will appear below the submit message. They provide completion + for the aliases/public user names specified in the + \e{User/alias configuration file} as well as a button that opens the + aforementioned user name dialog. */