[alsa-devel] [PATCH - alsa-utils 4/5] Documentation manual page for amidicat

[Josh Lehan]

On 06/30/2014 04:32 AM, Clemens Ladisch wrote:
> Josh Lehan wrote:
>> +++ b/amidicat/amidicat.1
>> +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
> 
> So this is not the actual source code?

It is.  In my original release I wrote the documentation page in DocBook
format.  This was handy, because both HTML and manpage formats could be
rendered from there.

However, I noticed DocBook wasn't used anywhere else in alsa-utils, and
I didn't want to pull in an external package just for that, so I made
the manpage format primary.  The "Generator" comment is now superfluous,
I will remove it.

>> +\fB\-\-hex\fR
>> ...
>> +If this option is not given, the default is raw binary data\&.
> 
> This is the only place in the documentation where the default input/
> output format is described.  Please move it to a more prominent
> location.

Good idea, thanks.

Josh