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

Best practices on updating documentation?

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 13, 2013, 20:42 UTC
Message-ID
<20131013204240.GD865149@vauxhall.crustytoothpaste.net>

If I'm going to be adding an option to a command, should I update the documentation in the same commit or in a separate commit?

-- 
brian m. carlson / brian with sandals: Houston, Texas, US
+1 832 623 2791 | http://www.crustytoothpaste.net/~bmc | My opinion only
OpenPGP: RSA v4 4096b: 88AC E9B2 9196 305B A994 7552 F1BA 225C 0223 B187
Next: John Keeping
Message 1 of 2 in “Best practices on updating documentation?”
  1. brian m. carlsonOct 13, 2013
  2. John KeepingOct 13, 2013

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.