Developers of Sympa

[IKEDA Soji <address@concealed>]

Hi,

On Mon, 13 Jan 2014 19:44:52 +0100 (CET)
address@concealed wrote:

> sympa[10157] trunk/src: [dev] install man page for foobar.pl binary as 
> foobar.pl.X instead of foobar.X, so as keep sympa.8 name free for a generic 
> man page
> Revision 10157 Author rousse Date 2014-01-13 19:44:52 +0100 (lun. 13 janv. 
> 2014)
> Log Message[dev] install man page for foobar.pl binary as foobar.pl.X 
> instead of foobar.X, so as keep sympa.8 name free for a generic man page

I don't agree to this policy.

o Generic man page sympa.X may not be put in section 8 (I don't
  know what is "generic", though).  I suppose there are no reason to
  reserve the file name "sympa.8".

o By previous commit r10156, man pages became directly generated
  from corresponding scripts: Intermediate PODs are no longer used.
  We can take one more step.  If man pages were named as NAME.X,
  makefile will be simplified using suffix rule, then, redundant
  rules such as "sympa.8: sympa.pl" are no longer required.

  | man8_MANS = archived.8 bounced.8 alias_manager.8 sympa.8
  | 
  | .pl.8:
  |     rm -f $@
  |     $(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
  |     --lax --release="$(VERSION)" $< $@      

  [*see also note below]

o When the NAME section of POD is written as

  | =head1 NAME
  | 
  | sympa, sympa.pl - A Modern Mailing List Manager

  man page finally generated will indexed both with "sympa" and
  "sympa.pl" regardless to its file name, sympa.8 or sympa.pl.8
  (this is true at least on many Linux distributions).  I suppose
  file names of man pages need not include extension ".pl".


Some notes (relatively unimportant):

- I have another idea to rename "*.pl.in" to the name with single
  extension such as "*.pin".  Suffix rule ".pin.pl:" will simplify
  makefile more.
  ".in" suffix is originally used by autotools.  We need not stick
  to it.

- Naming of several programs are too generic: "archived", "bounced",
  "bulk", "task_manager", and in addition, "web_help" for
  translation catalog.
  There is a risk of conflict with files come from other packages.
  So in the future, they would be renamed to such as the name with
  "sympa_" prefix ("sympa_archived.pl", "sympa_help.mo" etc.).

- [really unimportant] aliaswrapper, virtualwrapper and
  alias_manager will be obsoleted.

Regards,

--- Soji




> Modified Paths
> trunk/src/bin/Makefile.am
> trunk/src/libexec/Makefile.am
> trunk/src/sbin/Makefile.am
> Diff
> Modified: trunk/src/bin/Makefile.am (10156 => 10157)
> --- trunk/src/bin/Makefile.am 2014-01-13 18:41:19 UTC (rev 10156)
> +++ trunk/src/bin/Makefile.am 2014-01-13 18:44:52 UTC (rev 10157)
> @@ -1,6 +1,6 @@
>  bin_SCRIPTS = sympa_wizard.pl sympa_soap_client.pl
>  
> -man1_MANS = sympa_wizard.1
> +man1_MANS = sympa_wizard.pl.1
>  
>  dbscripts = create_db.Pg create_db.mysql create_db.Oracle \
>           create_db.Sybase create_db.SQLite
> @@ -60,9 +60,9 @@
>  
>  .pl.1:
>  
> -sympa_wizard.1: Makefile
> +sympa_wizard.pl.1: Makefile
>       rm -f $@
>       $(AM_V_GEN)$(POD2MAN) --section=1 --center="sympa $(VERSION)" \
> -             --lax --release="$(VERSION)" $*.pl $@
> +             --lax --release="$(VERSION)" $* $@
>  
> -sympa_wizard.1: sympa_wizard.pl
> +sympa_wizard.pl.1: sympa_wizard.pl
>  Modified: trunk/src/libexec/Makefile.am (10156 => 10157)
> --- trunk/src/libexec/Makefile.am     2014-01-13 18:41:19 UTC (rev 10156)
> +++ trunk/src/libexec/Makefile.am     2014-01-13 18:44:52 UTC (rev 10157)
> @@ -2,7 +2,7 @@
>                 ldap_alias_manager.pl \
>                 mysql_alias_manager.pl
>  
> -man8_MANS = alias_manager.8
> +man8_MANS = alias_manager.pl.8
>  
>  EXTRA_DIST = alias_manager.pl.in \
>            ldap_alias_manager.pl.in \
> @@ -79,9 +79,9 @@
>  
>  .pl.8:
>  
> -alias_manager.8: Makefile
> +alias_manager.pl.8: Makefile
>       rm -f $@
>       $(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
> -             --lax --release="$(VERSION)" $*.pl $@
> +             --lax --release="$(VERSION)" $* $@
>  
> -alias_manager.8: alias_manager.pl
> +alias_manager.pl.8: alias_manager.pl
>  Modified: trunk/src/sbin/Makefile.am (10156 => 10157)
> --- trunk/src/sbin/Makefile.am        2014-01-13 18:41:19 UTC (rev 10156)
> +++ trunk/src/sbin/Makefile.am        2014-01-13 18:44:52 UTC (rev 10157)
> @@ -4,11 +4,11 @@
>              sympa.pl \
>              task_manager.pl
>  
> -man8_MANS = archived.8 \
> -         bounced.8 \
> -         bulk.8 \
> -         sympa.8 \
> -         task_manager.8
> +man8_MANS = archived.pl.8 \
> +         bounced.pl.8 \
> +         bulk.pl.8 \
> +         sympa.pl.8 \
> +         task_manager.pl.8
>  
>  EXTRA_DIST = archived.pl.in \
>            bounced.pl.in \
> @@ -38,15 +38,15 @@
>  sympa.pl: $(srcdir)/sympa.pl.in
>  task_manager.pl: $(srcdir)/task_manager.pl.in
>  
> -archived.8 bounced.8 bulk.8 sympa.8 task_manager.8: Makefile
> +archived.pl.8 bounced.pl.8 bulk.pl.8 sympa.pl.8 task_manager.pl.8: Makefile
>       rm -f $@
>       $(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
> -             --lax --release="$(VERSION)" $*.pl $@
> +             --lax --release="$(VERSION)" $* $@
>  
>  .pl.8:
>  
> -archived.8: archived.pl
> -bounced.8: bounced.pl
> -bulk.8: bulk.pl
> -sympa.8: sympa.pl
> -task_manager.8: task_manager.pl
> +archived.pl.8: archived.pl
> +bounced.pl.8: bounced.pl
> +bulk.pl.8: bulk.pl
> +sympa.pl.8: sympa.pl
> +task_manager.pl.8: task_manager.pl


-- 
株式会社 コンバージョン  セキュリティ&OSSソリューション部   池田荘児
〒231-0004　神奈川県横浜市中区元浜町3-21-2 ヘリオス関内ビル7F
e-mail address@concealed  TEL 045-640-3550
http://www.conversion.co.jp/