| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Date: Fri, 10 Aug 2007 16:40:25 -0400 From: "J. Bruce Fields" <bfields@...ldses.org> To: Willy Tarreau <w@....eu> Cc: Stephen Hemminger <shemminger@...ux-foundation.org>, linux-kernel@...r.kernel.org Subject: Re: Documentation files in html format? On Fri, Aug 10, 2007 at 10:17:04PM +0200, Willy Tarreau wrote: > I've read pro-plain text arguments, so I'll not repeat them. I also see > another advantage to plain text : it's very easy to draw ascii-art > diagrams of anything. It only takes a few minutes, is always inline > and readable with any tool. Asciidoc should preserve ascii-art diagrams OK; the git docs use them all over. Not that I'd necessarily push asciidoc. But: > I'd prefer that you define some writing conventions for plain-text > documents that anyone should try follow, starting with the 80-cols > limit to make Davem happy. I think that many of us can help define > such a "standard" indicating how to underline subtitles, how to > enumerate a list, how to avoid using tabs, how to write boxes and > arrows in their diagrams, etc... ... at the point where you actually start setting standards for subtitle underlining and list enumeration, you'd want to take another look at asciidoc; since it already defines conventions for that stuff (which are probably close to what people would do anyway), it might make sense just to start using asciidoc. --b. - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@...r.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists