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

Improve 'git help' with basic user guide linkss

From
Philip Oakley <philipoakley@iee.org>
Date
Feb 8, 2013, 20:17 UTC
Message-ID
<6D91D31A093D46869F43DD8D1012F0FB@PhilipOakley>

I'm looking at extending the 'git help' to include some information for the basic user who isn't ready for the extensive man page documentation for the various commands.

If the user doesn't yet know which is the relevant command then they should also be offered a clue on how to finding the various guides. Many users are stuck on the 'If I were you I wouldn't start from here' step (many blog comments on the alleged poor documentation and difficulty of understanding ...).

I've started on adding a few tweaks to the basic 'git help' message, adding an end line indicating that there are guides, such as 'tutorial'. Initial hacks at https://github.com/PhilipOakley/git/commits/morehelp for thos interested.

My real question is on the right approach to generating a list of guides and including them into the git help options. I'm planning on extending the command-list.txt file to include 'guides' and then extending the generate-cmdlist.sh to generate a guides array in common-cmds.h.

I'm thinking of adding -g --guides and -c --commands options to complement the existing -a --all (becomes both commands and guides) option. I'm not yet sure how to determine which other special guides should be listed (api- etc.) and when.

I was expecting to update the user-manual. to become gituser-manual.txt so that the existing 'git help user-manual' scheme would discover it. The Tutorial and the User manual obviously(?) being the first port of call for the confused user.

Does this appear sensible, and should the Documentation/* directories also be searched for 'guides', or is that a step too far [and it's less coding] ?

Philip Oakley
Next: Junio C Hamano
Message 1 of 8 in “Improve 'git help' with basic user guide linkss”
  1. Philip OakleyFeb 8, 2013
  2. Junio C HamanoFeb 8, 2013
  3. Philip OakleyFeb 8, 2013
  4. Junio C HamanoFeb 8, 2013
  5. Philip OakleyFeb 8, 2013
  6. Philip OakleyFeb 12, 2013
  7. John KeepingFeb 12, 2013
  8. Philip OakleyFeb 12, 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.