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

Re: Support 'help' for custom/alias commands

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Feb 9, 2020, 16:38 UTC
Message-ID
<20200209163857.GA7054@camp.crustytoothpaste.net>
In-Reply-To
<00df01d5df4a$e422af70$ac680e50$@pauldsmith.org.uk>
On 2020-02-09 at 13:14:42, paul@pauldsmith.org.uk wrote:
Show 5 quoted lines
> Brian,
> 
> Thanks for considering this.  I've not tried MANPATH but will take a look - my employers use both Linux and Windows so this would only address half the issue but I also understand your comments on "one config to rule them all" and the HTML/MAN issue.
> 
> I've used ASCIIDOCTOR already to create config but I feel it would be nice if that could be rolled up into some sort of bundle but it users don't want Ruby then yes, it's not going to work for them.  My personal take is that anyone wanting docs for their custom applications should create them like core Git does - and with Docker and similar it's easy to isolate an environment so perhaps a Docker image might be the way to go.

I don't see a problem with us shipping the stylesheets and tooling we use for our conversions as something people can use, and then if they want to install AsciiDoc or Asciidoctor, they can use the same scripts. That wouldn't be that hard to do.

Personally, though, I find that I don't benefit from them much when I write documentation, and so I don't use them. Other people may feel differently, though.

-- 
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204
Previous: paul@pauldsmith.org.uk
Message 6 of 6 in “Support 'help' for custom/alias commands”
  1. paul@pauldsmith.org.ukFeb 7, 2020
  2. Konstantin KhomoutovFeb 7, 2020
  3. paul@pauldsmith.org.ukFeb 9, 2020
  4. brian m. carlsonFeb 7, 2020
  5. paul@pauldsmith.org.ukFeb 9, 2020
  6. brian m. carlsonFeb 9, 2020

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.