Re: [pacman-dev] Documentation and manpages [was: Release Schedule for 3.0]
On 2/6/07, Aaron Griffin <aaronmgriffin@gmail.com> wrote:
I will see what i can do about the -S/-Su check AND makepkg documentation in the next few hours.
For manpages, what is our call? I feel like I may get stuck updating some of this, and this is my proposal: pacman.8: Similar to current pacman manpage, just updated/corrected for new options. makepkg.8: Document the makepkg program itself- eg command line flags, makepkg.conf if that is not a separate manpage, and refer people to PKGBUILD.5 for actual reference on building packages. PKGBUILD.5: Documentation for the actual format of a PKGBUILD, documenting all possible options and arrays,etc. libalpm.3: Actual documentation of the library functions. As well still want to clean this up, this is probably a low priority manpage, and the doxygen ones will suffice for now. Other possibilities: makepkg.conf.? pacman.conf.? Thoughts on this? -Dan
2007/2/6, Dan McGee <dpmcgee@gmail.com>:
On 2/6/07, Aaron Griffin <aaronmgriffin@gmail.com> wrote:
I will see what i can do about the -S/-Su check AND makepkg documentation in the next few hours.
For manpages, what is our call? I feel like I may get stuck updating some of this, and this is my proposal: pacman.8: Similar to current pacman manpage, just updated/corrected for new options. makepkg.8: Document the makepkg program itself- eg command line flags, makepkg.conf if that is not a separate manpage, and refer people to PKGBUILD.5 for actual reference on building packages. PKGBUILD.5: Documentation for the actual format of a PKGBUILD, documenting all possible options and arrays,etc. libalpm.3: Actual documentation of the library functions. As well still want to clean this up, this is probably a low priority manpage, and the doxygen ones will suffice for now.
Other possibilities: makepkg.conf.? pacman.conf.?
Thoughts on this?
makepkg.conf and pacman.conf may deserve own manpages. :-/ -- Roman Kyrylych (Роман Кирилич)
Ok, work divvying time! I'm going to do PKGBUILD.5 right now. This includes a move from PKGBUILD.8 and stripping the frugalware stuff that we didn't merge (Finclude, SBU, etc) pacman.8 and makepkg.8 should just need cleanup and option addition. libalpm.3, I'd say we rely wholly on doxygen generated pages, and symlinks for this (see the way libarchive does it). makepkg.conf and pacman.conf probably need man pages as well - anyone equal to the task?
On 2/6/07, Aaron Griffin <aaronmgriffin@gmail.com> wrote:
Ok, work divvying time!
I'm going to do PKGBUILD.5 right now. This includes a move from PKGBUILD.8 and stripping the frugalware stuff that we didn't merge (Finclude, SBU, etc)
Forgot this, and I posted it on the ML a long time ago: <http://www.archlinux.org/~dan/PKGBUILD.5> -Dan
This is a proposal to clean up our build system a bit. Currently, the translated manpages are generated using a tool called po4a, which seems to be a rather contrived way to generate just a few things. Would it be easier for translators to just translate the whole manpage, in its original form? This would greatly simplify this side of the documentation keeping, and we could develop a system to figure out when our translated manpages need updating. In addition, it seems to make sense to just move the manpages to their real name (pacman.8) instead of automake/autoconf input files (pacman.8.in). There isn't much reason to have these preprocessed. All of this would make working on the documentation a lot less intimidating, in my opinion. Thoughts? -Dan
On 2/6/07, Dan McGee <dpmcgee@gmail.com> wrote:
This is a proposal to clean up our build system a bit. Currently, the translated manpages are generated using a tool called po4a, which seems to be a rather contrived way to generate just a few things. Would it be easier for translators to just translate the whole manpage, in its original form? This would greatly simplify this side of the documentation keeping, and we could develop a system to figure out when our translated manpages need updating.
In addition, it seems to make sense to just move the manpages to their real name (pacman.8) instead of automake/autoconf input files (pacman.8.in). There isn't much reason to have these preprocessed.
All of this would make working on the documentation a lot less intimidating, in my opinion. Thoughts?
You already know I'm for it. Heh.
On 2/6/07, Aaron Griffin <aaronmgriffin@gmail.com> wrote:
On 2/6/07, Dan McGee <dpmcgee@gmail.com> wrote:
This is a proposal to clean up our build system a bit. Currently, the translated manpages are generated using a tool called po4a, which seems to be a rather contrived way to generate just a few things. Would it be easier for translators to just translate the whole manpage, in its original form? This would greatly simplify this side of the documentation keeping, and we could develop a system to figure out when our translated manpages need updating.
In addition, it seems to make sense to just move the manpages to their real name (pacman.8) instead of automake/autoconf input files (pacman.8.in). There isn't much reason to have these preprocessed.
All of this would make working on the documentation a lot less intimidating, in my opinion. Thoughts?
You already know I'm for it. Heh.
Anyone else?
2007/2/7, Aaron Griffin <aaronmgriffin@gmail.com>:
On 2/6/07, Aaron Griffin <aaronmgriffin@gmail.com> wrote:
On 2/6/07, Dan McGee <dpmcgee@gmail.com> wrote:
This is a proposal to clean up our build system a bit. Currently, the translated manpages are generated using a tool called po4a, which seems to be a rather contrived way to generate just a few things. Would it be easier for translators to just translate the whole manpage, in its original form? This would greatly simplify this side of the documentation keeping, and we could develop a system to figure out when our translated manpages need updating.
In addition, it seems to make sense to just move the manpages to their real name (pacman.8) instead of automake/autoconf input files (pacman.8.in). There isn't much reason to have these preprocessed.
All of this would make working on the documentation a lot less intimidating, in my opinion. Thoughts?
You already know I'm for it. Heh.
Anyone else?
I never did any .po or man translation, but I think just making a copy of manpage and translate it to another language will be much simpler than with po4a. -- Roman Kyrylych (Роман Кирилич)
participants (3)
-
Aaron Griffin
-
Dan McGee
-
Roman Kyrylych