git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 0/3] Documenting naming rules for configuration variables

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 28, 2015, 22:33 UTC
Message-ID
<1422484393-4414-1-git-send-email-gitster@pobox.com>
In-Reply-To
<xmqqiofskmfd.fsf@gitster.dls.corp.google.com>

So here is a rewrite of the same but split into three patches, after seeing "add.ignore-errors" not marked exactly as deprecated.

The update to CodingGuidelines goes a bit beyond how to name things (i.e. bumpyCase vs dashed-words, the latter of which is strongly discouraged) but how the names should be structured (i.e. no unbounded set of things as variable names).

We may have to also be careful about underscores (there is one I know about: gitweb.remote_heads that is used by instaweb), which might be a good starter topic for somebody new to the codebase.

Junio C Hamano (3):
  config.txt: clarify that add.ignore-errors is deprecated
  config.txt: mark deprecated variables more prominently
  CodingGuidelines: describe naming rules for configuration variables
 Documentation/CodingGuidelines | 25 +++++++++++++++++++++++++
 Documentation/config.txt       | 15 +++++++--------
 2 files changed, 32 insertions(+), 8 deletions(-)
-- 
2.3.0-rc2-149-gdd42ee9
Previous: Junio C HamanoNext: Junio C Hamano
Message 4 of 16 in “Documentation/git-add.txt: add `add.ginore-errors` configuration variable”
  1. Documentation/git-add.txt: add `add.ginore-errors` configuration variableAlexander Kuleshov, Jan 26, 2015
  2. Eric SunshineJan 26, 2015
  3. Junio C HamanoJan 27, 2015
  4. 0/3 Documenting naming rules for configuration variablesJunio C Hamano, Jan 28, 2015
  5. 1/3 config.txt: clarify that add.ignore-errors is deprecatedJunio C Hamano, Jan 28, 2015
  6. 2/3 config.txt: mark deprecated variables more prominentlyJunio C Hamano, Jan 28, 2015
  7. 3/3 CodingGuidelines: describe naming rules for configuration variablesJunio C Hamano, Jan 28, 2015
  8. Michael HaggertyFeb 1, 2015
  9. Jeff KingFeb 1, 2015
  10. Junio C HamanoFeb 1, 2015
  11. Jeff KingFeb 1, 2015
  12. Junio C HamanoFeb 1, 2015
  13. Johannes SchindelinFeb 2, 2015
  14. Junio C HamanoFeb 2, 2015
  15. Michael HaggertyFeb 2, 2015
  16. Junio C HamanoFeb 2, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.