Hi

I submitted the patch: https://review.gerrithub.io/#/c/361752/

Few things to be noted:

1. I divided the single man page into multiple man pages. So each FSAL 
as its own man page (ex: ganesha-ceph-config). I added man page for 
config options such as NFS_Parameters, Cache, Export etc. I think its 
much easier to edit and follow if we have smaller man pages.

2. For some fsal like Gluster and GPFS, I did not know all the 
information. So its more like a template for now.

3. I added a new option , USE_MAN_PAGE. Man page requires sphinx. So, it 
will fail in case not found.

4. For now, I have added support just for man page. But in future if we 
want to export it to a website in html format, I can add that part of 
code too.

For easy reading you can also have look at individual man pages in 
github: 
https://github.com/supriti/nfs-ganesha/tree/ganesha_service_file/src/doc/man 


Thanks,

Supriti


On 04/24/2017 03:00 PM, Daniel Gryniewicz wrote:
> I think this is a good idea.  Maintaining raw man pages has always been
> a bit of a pain.
>
> Daniel
>
> On 04/23/2017 04:53 PM, Supriti Singh wrote:
>> Hello all,
>>
>> I recently submitted a patch for man page for NFS-Ganesha configuration
>> options.
>>
>> I would like to suggest using sphinx tool for documentation. Similar to
>> what ceph is using https://github.com/ceph/ceph/tree/master/doc
>>
>> The doc can be written in ReStructured text markdown format, and can be
>> compiled into various formats such as man, html, pdf and latex. Its
>> easier to maintain, and easier for others to change.
>>
>> I have re-written the current patch in rst format. I have attached the
>> rst file and man file generated using sphinx. I am still working on the
>> format.
>>
>> Let me know your thoughts. Going ahead, we can think of converting
>> existing documents into rst.
>>
>> Thanks,
>> Supriti
>>
>>
>> ------
>> Supriti Singh
>> SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>> HRB 21284 (AG Nürnberg)
>>
>>
>>
>> ------------------------------------------------------------------------------
>> Check out the vibrant tech community on one of the world's most
>> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
>>
>>
>>
>> _______________________________________________
>> Nfs-ganesha-devel mailing list
>> Nfs-ganesha-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/nfs-ganesha-devel
>>
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Nfs-ganesha-devel mailing list
> Nfs-ganesha-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/nfs-ganesha-devel
>


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Nfs-ganesha-devel mailing list
Nfs-ganesha-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs-ganesha-devel

Reply via email to