Le 21.03.2013 16:31, Junio C Hamano a écrit :
Yann Droneaud <ydrone...@opteya.com> writes:

The documentation is in AsciiDoc format: it should be written somewhere
with links to AsciiDoc documentation so that it became easy to find
how to write documentation for Git.

Certainly this does not deserve a *new* file to hold it.

That's the first one I look for.

There were no indication about how to write documentation
in SubmittingPatches.

Later, I've found the only useful piece of advice regarding the documentation
in howto/new-command.txt:

What every extension command needs

You must have a man page, written in asciidoc (this is what Git help
followed by your subcommand name will display).  Be aware that there is
a local asciidoc configuration and macros which you should use.  It's
often helpful to start by cloning an existing page and replacing the
text content.

And I was grep'ing for ascii[ _-]doc throughout the sources !

Isn't this inferrable from the top-level INSTALL already?

In short: No.

You want me to look in the INSTALL file to search for the syntax
to write documentation ?

For someone who don't follow Git development, it's really not the file you're looking for.


Yann Droneaud

To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to