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

Re: markdown 2 man, was Re: Git Community Book

From
Jan Krüger <jk@jk.gs>
Date
Jul 31, 2008, 20:57 UTC
Message-ID
<20080731225703.7be6f76e@neuron>
In-Reply-To
<4891A0D0.6060503@lyx.org>
Hi,
> Disclaimer: I am involved in LyX development, so anything I said will
> be biased :-)

I think that's fine since I consider LaTeX (and therefore LyX as the best graphical editor for it that I know) a choice always worth considering when it comes to projects that have the size of a book.

> Now, about my shameless plug: LyX is ideally suited for structured 
> documentation writing :-)

That may well be, but it gets really complicated once you want to get your document into other markup-based formats while preserving all the important aspects of formatting. I know this because I started using LaTeX for a project that was supposed to be available in HTML form along with, say, PDF. I've found that the only converter that comes close to being useful for somewhat more ambitious sources (including, perhaps, custom environments and stuff like that) without spending a ridiculous amount of time trying to understand it is hevea. Of course, hevea only translates to HTML, so, for example, generating manpages or plain text is an entirely different matter of considerable difficulty.

In addition to that, I suspect that LyX files might be difficult to deal with in forky Git situations. For example, what if two separately contributed patches need merging into a LyX source file? This will only work automatically if the LyX source, treated as plain text, has a really low chance of randomly changing in other places than what the patch is supposed to touch. Also, if a merge does cause a conflict, I imagine it would be difficult to resolve that.

Finally, it's pretty much a given that Git's manpages continue to use AsciiDoc because there are few other things that can generate actual manpages. I'm not sure it would be a good idea to keep half of Git's documentation in one format and the rest in another. And AsciiDoc is -- by far! -- not the worst choice. I'm tempted to say it's the best that I know.

-Jan
Previous: Abdelrazak YounesNext: Abdelrazak Younes
Message 24 of 39 in “Git Community Book”
  1. Scott ChaconJul 29, 2008
  2. Miklos VajnaJul 29, 2008
  3. Petr BaudisJul 29, 2008
  4. Scott ChaconJul 29, 2008
  5. Junio C HamanoJul 29, 2008
  6. Julian PhillipsJul 29, 2008
  7. Junio C HamanoJul 29, 2008
  8. markdown 2 man, was Re: Git Community BookJohannes Schindelin, Jul 30, 2008
  9. Junio C HamanoJul 30, 2008
  10. Wincent ColaiutaJul 30, 2008
  11. Scott ChaconJul 31, 2008
  12. Junio C HamanoJul 31, 2008
  13. Abdelrazak YounesJul 31, 2008
  14. Stephan BeyerJul 31, 2008
  15. Abdelrazak YounesJul 31, 2008
  16. Abdelrazak YounesJul 31, 2008
  17. Miklos VajnaJul 31, 2008
  18. Abdelrazak YounesJul 31, 2008
  19. Miklos VajnaJul 31, 2008
  20. Junio C HamanoAug 1, 2008
  21. Abdelrazak YounesAug 1, 2008
  22. Thomas RastAug 1, 2008
  23. Abdelrazak YounesAug 1, 2008
  24. Jan KrügerJul 31, 2008
  25. Abdelrazak YounesAug 1, 2008
  26. Dmitry PotapovAug 1, 2008
  27. Abdelrazak YounesAug 1, 2008
  28. Scott ChaconJul 29, 2008
  29. Junio C HamanoJul 29, 2008
  30. J. Bruce FieldsJul 30, 2008
  31. Junio C HamanoJul 29, 2008
  32. Junio C HamanoJul 29, 2008
  33. Scott ChaconJul 29, 2008
  34. Scott ChaconJul 29, 2008
  35. Daniel BarkalowJul 29, 2008
  36. Junio C HamanoJul 29, 2008
  37. Bart TrojanowskiJul 30, 2008
  38. Junio C HamanoJul 30, 2008
  39. Bart TrojanowskiJul 30, 2008

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.