Re: [PATCH 0/3] Improve Kernel documentation guide

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Em Mon, 21 Nov 2016 17:21:38 -0200
Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> escreveu:

> > My preference, honestly, would be to put the documentation in RST and
> > maintain that as the definitive documentation for the tool.  It's not as
> > if there's going to be a lot of interactive users of parse-headers.pl...
> > I really don't like having two separate documents that will invariably
> > drift.  
> 
> Well, I still think that having a command line help is a good
> thing, at least while it can be run via command line. Of course,
> it woudn't make sense to have any help inside it, if this were a
> Sphinx extension.

Ok, let's try to be in the mid term ;)

Just sent you a patch that cleans the documentation inside the
script and add a mention to its ReST documentation. Now, the
in-script doc will only describe its arguments, but the details
about the exceptions file is all inside the ReST.

I also removed that notice to keep them in sync.

I hope that you're now happier :-)

Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux