On Wed, Apr 02, 2014 at 04:29:11PM +0800, Qu Wenruo wrote: > Convert the old btrfs man pages to new asciidoc and split the huge > btrfs man page into subcommand man page.
Excellent! > The asciidoc style and Makefile things are mostly simplified from git > Documentation, which only supports man page output and remove html output, > since html output is somewhat overkilled for btrfs. Well, I've been thinking about automatically pushing the man pages to wiki, with asciidoc it would be much easier, the formatting capabilities are better than what *roff provides. > 1) More human-readable raw documentations. > The roff grammar is not so easy to read, especially mixed with a lot > of special words. > > 2) Easier to modify man page. > The old huge btrfs man page makes it hard to maintain. > It's common that some one adds some new options, but only modifies > the detailed options but not the 'SYNOPSIS' section. I hope both points will encourage more people to contribute to the documentation. -- To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
