Re: [Frugalware-devel] [PATCH] Refactor manpages in AUTHORS regard
On Sun, Nov 22, 2009 at 11:24:51PM +0100, Laszlo Papp djsz...@archlinux.us wrote: Yeah, it's worth I think so, just see other package manager on other distribution, it's a 'standard' to involve the AUTHORS name in the manpage of the tools even not everybody developer all the tools. What do you think ? I think in most cases the AUTHOR section of a manpage mentions: (Did you notice that the name is 'AUTHOR', not 'AUTHORS'?) 1) the original author (maybe a bit more, but really not more) or 2) a website or file path where the complete list can be viewed. See, if a project has 700 contributors, you can't include all of them at the bottom of a manpage, right? Just two examples: - The git project usually just mentions the original author and the git list. See the manpage of git-merge, I am the author of the current code, but given that I just rewrote it in C while it was in sh previously, I did not put my name to the manpage. - The mplayer project has originally written by X Y, see the AUTHORS file for a complete list. I thought including 4 was already too long, that's why I changed the explicit list to a file path. Now that we are about 7 you would change this back just to show up your name in every manpage. No, that's a no-go. pgpY3nYByeyWK.pgp Description: PGP signature ___ Frugalware-devel mailing list Frugalware-devel@frugalware.org http://frugalware.org/mailman/listinfo/frugalware-devel
Re: [Frugalware-devel] [PATCH] Refactor manpages in AUTHORS regard
On Mon, Nov 23, 2009 at 10:29 AM, Miklos Vajna vmik...@frugalware.org wrote: On Sun, Nov 22, 2009 at 11:24:51PM +0100, Laszlo Papp djsz...@archlinux.us wrote: Yeah, it's worth I think so, just see other package manager on other distribution, it's a 'standard' to involve the AUTHORS name in the manpage of the tools even not everybody developer all the tools. What do you think ? I think in most cases the AUTHOR section of a manpage mentions: (Did you notice that the name is 'AUTHOR', not 'AUTHORS'?) Yeah. 1) the original author (maybe a bit more, but really not more) or 2) a website or file path where the complete list can be viewed. See, if a project has 700 contributors, you can't include all of them at the bottom of a manpage, right? It's a radical example, but I agree with you here. Just two examples: - The git project usually just mentions the original author and the git list. See the manpage of git-merge, I am the author of the current code, but given that I just rewrote it in C while it was in sh previously, I did not put my name to the manpage. - The mplayer project has originally written by X Y, see the AUTHORS file for a complete list. I thought including 4 was already too long, that's why I changed the explicit list to a file path. Now that we are about 7 you would change this back just to show up your name in every manpage. No, that's a no-go. Archlinux pacman manpage mentions 5 authors, but I agree with you, sorry If i robbed your time. Best Regards, Laszlo Papp ___ Frugalware-devel mailing list Frugalware-devel@frugalware.org http://frugalware.org/mailman/listinfo/frugalware-devel
[Frugalware-devel] [PATCH] Refactor manpages in AUTHORS regard
* Add 'include::../AUTHORS[]' expression to the following man pages: - doc/FrugalBuild.txt - doc/libpacman.txt - doc/makepkg.txt - doc/pacman-g2.txt * The purpose of this implementation is that the AUTHORS can be seen immediately during browsing the man pages. * Refactor AUTHORS file, because of two reason: * Change Miklós Vajnai to Miklos Vajnai, because the utf8 support is not so strong on Frugalware, and the earlier implementation would have required that usage * Asciidoc can't handle the line breaks in the include files at this momment, so the only reasonable solution was here to indent the contact lines of contributors. --- AUTHORS | 14 +++--- doc/FrugalBuild.txt |4 +--- doc/libpacman.txt |4 +--- doc/makepkg.txt |4 +--- doc/pacman-g2.txt |4 +--- 5 files changed, 11 insertions(+), 19 deletions(-) diff --git a/AUTHORS b/AUTHORS index e5ca341..e023959 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,16 +1,16 @@ pacman-g2 authors - -Mikl�s Vajna vmik...@frugalware.org -Christian Hamar alias krix kr...@linuxforum.hu + Miklos Vajna vmik...@frugalware.org + Christian Hamar alias krix kr...@linuxforum.hu -Laszlo Papp djsz...@archlinux.us -Josh Wheeler deltal...@gmail.com -David Kimpe dn...@frugalware.org + Laszlo Papp djsz...@archlinux.us + Josh Wheeler deltal...@gmail.com + David Kimpe dn...@frugalware.org pacman authors -- -Judd Vinet jvi...@zeroflux.org -Aurelien Foret orel...@chez.com + Judd Vinet jvi...@zeroflux.org + Aurelien Foret orel...@chez.com If you think that you're missing from here, please contact us. diff --git a/doc/FrugalBuild.txt b/doc/FrugalBuild.txt index b3bc959..7591eee 100644 --- a/doc/FrugalBuild.txt +++ b/doc/FrugalBuild.txt @@ -469,6 +469,4 @@ it! include::bugs.txt[] -== AUTHORS - -See /usr/share/doc/pacman-g2-*/AUTHORS. +include::../AUTHORS[] diff --git a/doc/libpacman.txt b/doc/libpacman.txt index 13a3055..0911f8e 100644 --- a/doc/libpacman.txt +++ b/doc/libpacman.txt @@ -20,9 +20,7 @@ pacman_packages:: Package Functions pacman_sync:: Sync Functions pacman_trans:: Transaction Functions -== AUTHORS - -See /usr/share/doc/pacman-g2-*/AUTHORS. +include::../AUTHORS[] == REPORTING BUGS diff --git a/doc/makepkg.txt b/doc/makepkg.txt index d64658e..f3ba875 100644 --- a/doc/makepkg.txt +++ b/doc/makepkg.txt @@ -163,6 +163,4 @@ variables. Some of them are flaky... include::bugs.txt[] -== AUTHORS - -See /usr/share/doc/pacman-g2-*/AUTHORS. +include::../AUTHORS[] diff --git a/doc/pacman-g2.txt b/doc/pacman-g2.txt index 38f832c..d0c532d 100644 --- a/doc/pacman-g2.txt +++ b/doc/pacman-g2.txt @@ -440,6 +440,4 @@ post_sysupgrade:: include::bugs.txt[] -== AUTHORS - -See /usr/share/doc/pacman-g2-*/AUTHORS. +include::../AUTHORS[] -- 1.6.4 ___ Frugalware-devel mailing list Frugalware-devel@frugalware.org http://frugalware.org/mailman/listinfo/frugalware-devel
Re: [Frugalware-devel] [PATCH] Refactor manpages in AUTHORS regard
On Sun, Nov 22, 2009 at 10:05:49PM +0100, Laszlo Papp djsza...@gmail.com wrote: * Change Miklós Vajnai to Miklos Vajnai NAK. My last name is not Vajnai. , because the utf8 support is not so strong on Frugalware, and the earlier implementation would have required that usage 'utf8 support is not so strong' is a bullshit from a technical point of view. Please elaborate. Also, this would make 'man makepkg' show up your name while you did not touch that script at all, so it would make the manpage show invalid infos. Are you sure it worths the effort at all? pgpC1W4jBF9Ru.pgp Description: PGP signature ___ Frugalware-devel mailing list Frugalware-devel@frugalware.org http://frugalware.org/mailman/listinfo/frugalware-devel
Re: [Frugalware-devel] [PATCH] Refactor manpages in AUTHORS regard
On Sun, Nov 22, 2009 at 11:19 PM, Miklos Vajna vmik...@frugalware.org wrote: On Sun, Nov 22, 2009 at 10:05:49PM +0100, Laszlo Papp djsza...@gmail.com wrote: * Change Miklós Vajnai to Miklos Vajnai NAK. My last name is not Vajnai. Sorry, I will correct it. , because the utf8 support is not so strong on Frugalware, and the earlier implementation would have required that usage 'utf8 support is not so strong' is a bullshit from a technical point of view. Please elaborate. Also, this would make 'man makepkg' show up your name while you did not touch that script at all, so it would make the manpage show invalid infos. Are you sure it worths the effort at all? Yeah, it's worth I think so, just see other package manager on other distribution, it's a 'standard' to involve the AUTHORS name in the manpage of the tools even not everybody developer all the tools. What do you think ? I can send again this patch with the corrections, but I wouldn't like to work with unneccesary, but I think it's a standard and reasonable way to apply. Best Regards, Laszlo Papp ___ Frugalware-devel mailing list Frugalware-devel@frugalware.org http://frugalware.org/mailman/listinfo/frugalware-devel