{"thread":{"id":"61023","subject":"git-config doc: variables sorting bug","startedAt":"2024-02-28T10:15:10Z","lastAt":"2024-02-29T19:59:39Z","messageCount":4,"participants":["Bruno Haible","Eric Sunshine","Junio C Hamano"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"489608","messageId":"6139934.yKrmzQ4Hd0@nimes","threadId":"61023","inReplyTo":null,"subject":"git-config doc: variables sorting bug","fromName":"Bruno Haible","fromEmail":"bruno@clisp.org","sentAt":"2024-02-28T10:12:03Z","receivedAt":"2024-02-28T10:15:10Z","isPatch":false,"sender":{"key":"bruno@clisp.org","avatar":null},"body":"Hi,\n\nIn https://git-scm.com/docs/git-config the variables (advice.* ...\nworktree.guessRemote) are apparently meant to be in alphabetical order.\n\nHowever,\n filter..clean\n filter..smudge\ncome after format.*. They should come before format.*, since 'i' < 'o'.\n\nBruno\n\n\n\n"},{"id":"489676","messageId":"20240229190229.20222-1-ericsunshine@charter.net","threadId":"61023","inReplyTo":"6139934.yKrmzQ4Hd0@nimes","subject":"[PATCH] docs: sort configuration variable groupings alphabetically","fromName":"Eric Sunshine","fromEmail":"ericsunshine@charter.net","sentAt":"2024-02-29T19:02:29Z","receivedAt":"2024-02-29T19:04:27Z","isPatch":true,"sender":{"key":"ericsunshine@charter.net","avatar":null},"body":"From: Eric Sunshine \n\nBy and large, variable groupings in Documentation/config.txt are sorted\nalphabetically, though a few are not. Those outliers make it more\ndifficult to find a specific grouping when quickly running an eye over\nthe list to locate a variable of interest. Address this shortcoming by\nsorting the groupings alphabetically.\n\nNOTE: This change only sorts the top-level groupings (i.e. \"core.*\"\ncomes after \"completion.*\"); it does not touch the ordering of variables\nwithin each group since variables within individual groups might\nintentionally be ordered in some other fashion (such as\nmost-common-first or most-important-first).\n\nReported-by: Bruno Haible \nSigned-off-by: Eric Sunshine \n---\n Documentation/config.txt | 28 ++++++++++++++--------------\n 1 file changed, 14 insertions(+), 14 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex e3a74dd1c1..782c2bab90 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -369,20 +369,18 @@ inventing new variables for use in your own tool, make sure their\n names do not conflict with those that are used by Git itself and\n other popular tools, and describe them in your documentation.\n \n-include::config/advice.txt[]\n-\n-include::config/attr.txt[]\n-\n-include::config/core.txt[]\n-\n include::config/add.txt[]\n \n+include::config/advice.txt[]\n+\n include::config/alias.txt[]\n \n include::config/am.txt[]\n \n include::config/apply.txt[]\n \n+include::config/attr.txt[]\n+\n include::config/blame.txt[]\n \n include::config/branch.txt[]\n@@ -405,10 +403,12 @@ include::config/commit.txt[]\n \n include::config/commitgraph.txt[]\n \n-include::config/credential.txt[]\n-\n include::config/completion.txt[]\n \n+include::config/core.txt[]\n+\n+include::config/credential.txt[]\n+\n include::config/diff.txt[]\n \n include::config/difftool.txt[]\n@@ -421,10 +421,10 @@ include::config/feature.txt[]\n \n include::config/fetch.txt[]\n \n-include::config/format.txt[]\n-\n include::config/filter.txt[]\n \n+include::config/format.txt[]\n+\n include::config/fsck.txt[]\n \n include::config/fsmonitor--daemon.txt[]\n@@ -435,10 +435,10 @@ include::config/gitcvs.txt[]\n \n include::config/gitweb.txt[]\n \n-include::config/grep.txt[]\n-\n include::config/gpg.txt[]\n \n+include::config/grep.txt[]\n+\n include::config/gui.txt[]\n \n include::config/guitool.txt[]\n@@ -519,10 +519,10 @@ include::config/splitindex.txt[]\n \n include::config/ssh.txt[]\n \n-include::config/status.txt[]\n-\n include::config/stash.txt[]\n \n+include::config/status.txt[]\n+\n include::config/submodule.txt[]\n \n include::config/tag.txt[]\n-- \n2.44.0\n\n"},{"id":"489679","messageId":"CAPig+cSFW0MrAx6n3=142X64UraErTDHQxjGpgc6hy-=pbDSpQ@mail.gmail.com","threadId":"61023","inReplyTo":"6139934.yKrmzQ4Hd0@nimes","subject":"Re: git-config doc: variables sorting bug","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2024-02-29T19:08:45Z","receivedAt":"2024-02-29T19:08:57Z","isPatch":false,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Wed, Feb 28, 2024 at 5:15 AM Bruno Haible wrote:\n> In https://git-scm.com/docs/git-config the variables (advice.* ...\n> worktree.guessRemote) are apparently meant to be in alphabetical order.\n>\n> However,\n> filter..clean\n> filter..smudge\n> come after format.*. They should come before format.*, since 'i' < 'o'.\n\nA possible fix has been posted here:\nhttps://lore.kernel.org/git/20240229190229.20222-1-ericsunshine@charter.net/\n"},{"id":"489686","messageId":"xmqqmsrjdot3.fsf@gitster.g","threadId":"61023","inReplyTo":"20240229190229.20222-1-ericsunshine@charter.net","subject":"Re: [PATCH] docs: sort configuration variable groupings alphabetically","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-02-29T19:59:36Z","receivedAt":"2024-02-29T19:59:39Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine writes:\n\n> NOTE: This change only sorts the top-level groupings (i.e. \"core.*\"\n> comes after \"completion.*\"); it does not touch the ordering of variables\n> within each group since variables within individual groups might\n> intentionally be ordered in some other fashion (such as\n> most-common-first or most-important-first).\n\nI think this is a useful first step.\n\nIt is tempting to think, in this day and age, searching in a\ndocument is so easy to start with a single keystroke (either ^F in a\nbrowser, or '/' in a pager) that the ordering of entries does not\nmatter as much as it used to, but the reader may not know exactly\nwhat variable they are looking for, and a predictable ordering helps\nwhile they are browsing the list.\n\nWill queue. Thanks.\n"}]}