Re: Guidance on creating man pages for procd utilities

2021-08-18 Thread John Crispin 


On 19.08.21 03:24, Lucas Ramage wrote:

Greetings,

I would like to create man pages for uxc and some of the other utilities in the 
procd repository.

Searching through some of the commits in the openwrt/packages repository shows 
that man pages are intensionally disabled from being built,  but I still think 
they are helpful to have. Perhaps there could be -doc packages like in other 
distributions?

Please advise,


I normally use asciidoc or gitbook for documentation

    John


___
openwrt-devel mailing list
openwrt-devel@lists.openwrt.org
https://lists.openwrt.org/mailman/listinfo/openwrt-devel

Re: Guidance on creating man pages for procd utilities

2021-08-18 Thread Eric Luehrsen 

On 8/18/21 9:24 PM, Lucas Ramage wrote:

Greetings,

I would like to create man pages for uxc and some of the other utilities in the 
procd repository.

Searching through some of the commits in the openwrt/packages repository shows 
that man pages are intensionally disabled from being built,  but I still think 
they are helpful to have. Perhaps there could be -doc packages like in other 
distributions?

Please advise,


Doxygen would be nice. If used correctly, it can help one wrap their 
head around calls, structures, and requirements. The pretty HTML could 
be published with Github pages, or similar custom method. Yet being 
realistic, meaningful comments in the code would be nice. (hint)


- Eric


___
openwrt-devel mailing list
openwrt-devel@lists.openwrt.org
https://lists.openwrt.org/mailman/listinfo/openwrt-devel

Guidance on creating man pages for procd utilities

2021-08-18 Thread Lucas Ramage 
Greetings,

I would like to create man pages for uxc and some of the other utilities in the 
procd repository.

Searching through some of the commits in the openwrt/packages repository shows 
that man pages are intensionally disabled from being built,  but I still think 
they are helpful to have. Perhaps there could be -doc packages like in other 
distributions?

Please advise,

___
openwrt-devel mailing list
openwrt-devel@lists.openwrt.org
https://lists.openwrt.org/mailman/listinfo/openwrt-devel