On 03/19/2013 03:15 PM, Ben Laurie wrote:
> ...
>>> Very often people are able to comment, eg, a command page with some
>>> samples or error comments, instead of rewriting from scratch a "man
>>> page".
>>>
>>> And this could be a way to only have one unique set of docs to
>>> maintain, and to refer to, instead of having two...
>>
>> That's an interesting suggestion; I'll kick it around and see what kind
>> of traction it gets.
> 
> Seems like a good idea to me. It does raise the question of how you
> export back to the docs tho...

Agreed, as I think about this more I'm not seeing how we could do that
(same documentation in .pod files in the source repository and as
markdown in the wiki).

There are tools of a sort to convert between docbook, pod, and markdown.
I've played with a couple of them, but I think annoying little details
will keep such tools from representing any net labor savings over manual
cut-and-paste. So I'm left with the conclusion that in the wiki we
should just link to the .pod based pages at openssl.org/docs/

Now a link from those to the discussion in the wiki might be useful (I
think someone made that suggestion already). Perhaps as we accumulate
enough content to bother linking to.

-Steve M.

-- 
Steve Marquess
OpenSSL Software Foundation, Inc.
1829 Mount Ephraim Road
Adamstown, MD  21710
USA
+1 877 673 6775 s/b
+1 301 874 2571 direct
marqu...@opensslfoundation.com
marqu...@openssl.com
______________________________________________________________________
OpenSSL Project                                 http://www.openssl.org
Development Mailing List                       openssl-dev@openssl.org
Automated List Manager                           majord...@openssl.org

Reply via email to