From 03946a647fbb1dbb1125cdcace11f5076f9568fa Mon Sep 17 00:00:00 2001 From: Sven Selberg Date: Thu, 18 Jun 2020 08:26:48 +0200 Subject: [PATCH] config-project-config.txt: reformat submit-section This section had a strange format that made it hard to recognize the enumeration of the various submit options. Refactor it so that it's aligned with the other sections. Change-Id: I69d6dc081680eadf92ddbfcac881367c1367d4bd --- Documentation/config-project-config.txt | 40 ++++++++++++++----------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/Documentation/config-project-config.txt b/Documentation/config-project-config.txt index 71af331341..22d8a0dbf8 100644 --- a/Documentation/config-project-config.txt +++ b/Documentation/config-project-config.txt @@ -316,26 +316,32 @@ the parent project. The submit section includes configuration of project-specific submit settings: -- 'mergeContent': Defines whether to automatically merge changes. Valid values -are 'true', 'false', or 'INHERIT'. Default is 'INHERIT'. +[[submit.mergeContent]]submit.mergeContent:: ++ +Defines whether to automatically merge changes. Valid values are 'true', 'false', or 'INHERIT'. +Default is 'INHERIT'. -- 'action': defines the link:#submit-type[submit type]. Valid -values are 'fast forward only', 'merge if necessary', 'rebase if necessary', -'rebase always', 'merge always' and 'cherry pick'. The default is 'merge if necessary'. +[[submit.action]]submit.action:: ++ +Defines the link:#submit-type[submit type]. Valid values are 'fast forward only', +'merge if necessary', 'rebase if necessary', 'rebase always', 'merge always' and 'cherry pick'. +The default is 'merge if necessary'. -- 'matchAuthorToCommitterDate': Defines whether to the author date will be changed to match the -submitter date upon submit, so that git log shows when the change was submitted instead of when the -author last committed. Valid values are 'true', 'false', or 'INHERIT'. The default is 'INHERIT'. -This option only takes effect in submit strategies which already modify the commit, i.e. -Cherry Pick, Rebase Always, and (perhaps) Rebase If Necessary. - -- 'rejectEmptyCommit': Defines whether empty commits should be rejected when a change is merged. -Changes might not seem empty at first but when attempting to merge, rebasing can lead to an empty -commit. If this option is set to 'true' the merge would fail. An empty commit is still allowed as -the initial commit on a branch. - -Merge strategy +[[submit.matchAuthorToCommitterDate]]submit.matchAuthorToCommitterDate:: ++ +Defines whether the author date will be changed to match the submitter date upon submit, so that +git log shows when the change was submitted instead of when the author last committed. Valid +values are 'true', 'false', or 'INHERIT'. The default is 'INHERIT'. This option only takes effect +in submit strategies which already modify the commit, i.e. Cherry Pick, Rebase Always, and +(when rebase is necessary) Rebase If Necessary. +[[submit.rejectEmptyCommit]]submit.rejectEmptyCommit:: ++ +Defines whether empty commits should be rejected when a change is merged. When using +link:#submit.action[submit action] Cherry Pick, Rebase If Necessary or Rebase Always changes may +become empty upon submit, since the rebase|cherry-pick can lead to an empty commit. If this option +is set to 'true' the merge would fail in such a case. An empty commit is still allowed as the +initial commit on a branch. [[access-section]] === Access section