[PATCH] cgitrc.5: Clarify operation of sorting options

[Benjamin Linskey]

This updates the descriptions of the repository-sort and section-sort
options to clarify that no sorting whatsoever will be performed if
section-sort is set to 0. Prior to this change, the descriptions could
have been read as implying that the repository-sort criterion is always
applied within a section and that the section-sort option only controls
whether the sections themselves are sorted by name.

Signed-off-by: Benjamin Linskey <git at linskey.org>
---
A careful reading of the man page when I was initially setting up cgit
led me to the erroneous interpretation described above, so this change
may be helpful for other newcomers.

I've noticed that contributors typically sign-off on their commits, so
I did the same, but I haven't found an explanation of what that's
intended to signify in this project. I assume, of course, that it's the
usual matter of having the right to license the code and so forth, but
I don't see that spelled out anywhere.

- Ben

 cgitrc.5.txt | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7c39bf9..dd1f1d2 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -350,10 +350,11 @@ renamelimit::
 	  `man git-diff`). Default value: "-1".

 repository-sort::
-	The way in which repositories in each section are sorted. Valid values
-	are "name" for sorting by the repo name or "age" for sorting by the
-	most recently updated repository. Default value: "name". See also:
-	section, case-sensitive-sort, section-sort.
+	The way in which repositories in each section are sorted when
+	section-sort is set to "1". Valid values are "name" for sorting by the
+	repo name or "age" for sorting by the most recently updated repository.
+	Default value: "name". See also: section, case-sensitive-sort,
+	section-sort.

 robots::
 	Text used as content for the "robots" meta-tag. Default value:
@@ -397,9 +398,10 @@ section::

 section-sort::
 	Flag which, when set to "1", will sort the sections on the repository
-	listing by name. Set this flag to "0" if the order in the cgitrc file should
-	be preserved. Default value: "1". See also: section,
-	case-sensitive-sort, repository-sort.
+	listing by name and sort their contents by the criterion specified by
+	repository-sort. Set this flag to "0" if the order of sections and
+	repositories in the cgitrc file should be preserved. Default value:
+	"1". See also: section, case-sensitive-sort, repository-sort.

 section-from-path::
 	A number which, if defined prior to scan-path, specifies how many
--
2.55.0