Re: multiple @syntax

[Tom Howard]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Peter Simons wrote:
> Tom Howard writes:
> 
>  > I propose we remove the obsoleted tag and add the
>  > following macro
> 
>  > AX_OBSOLETE([MACRO_NAME],[WHEN],[DETAILS],[REPLACEMENT])
> 
>  > which prints out to the user that the macro is obsolete,
>  > when it was made obsolete and if specified the details
>  > and it's replacement. The doc generator would need to be
>  > modified to pick this up, but other that that, what do
>  > you think?
> 
> I think it is a very good idea. I was planning on going the
> other way round, I wanted to add an
> 
>   AC_OBSOLETE (THIS-MACRO-NAME, [SUGGESTION])
> 
> call to the source which is generated from the reason given
> at @obsoleted.
> 
> Inserting stuff into the m4 source would be much more
> difficult to get right than reading stuff out of the m4
> source, so I am all for it.
> 
> Could you put together the appropriate AX_OBSOLETE macro you
> have in mind and post it here? Plus some example of how it
> is used? Then I would see to it that the formatting engine
> can handle it.
> 
> By the way, I personally would omit the WHEN parameter. The
> user probably doesn't care much about that date, and the
> archive has this information in the @version tag already,
> therefore I wouldn't repeat it in that call.
> 

just a very quick version, untested at this stage, just to give an idea.
 Ideally DETAILS and REPLACEMENT should be optional, but I can't
remember how to do that of the top of my head.  I'll finish the licence
changes (there is a bit of a backlog at the moment) and then look at
this again.

dnl @synopsis AX_OBSOLETE(MACRO_NAME],[WHEN],[DETAILS],[REPLACEMENT])
AC_DEFUN([AX_OBSOLETE],[
        echo "Warning: $1 was made obsolete on $2"
        echo "$3"
        echo "Warning: Please replace with \'$4\'"
])

and here is an example

AC_DEFUN([AX_FOOBAR],[
# whatever is in here
])

AC_DEFUN([AC_FOOBAR],[
AX_OBSOLETE([AC_FOOBAR],[2005-01-24],[The Autoconf macro archive now
prefixes it's macros with AX_, rather than AC_.  This is in order to
prevent naming conflicts with macros from Autoconf.],[AX_FOOBAR])
AX_FOOBAR($1, $2, $3....)
])


Cheers,

- --
Tom Howard

Public Key: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x433B299A
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.5 (MingW32)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org

iD8DBQFB9Gf8w1G4ZUM7KZoRAqUrAJ4oOGzdG15F1Akg5o5iv7GcEmSE7wCfXFUp
mIKmosnDDGkItXq8oVPOzD8=
=DlwS
-----END PGP SIGNATURE-----

tomhoward.vcf
Description: Vcard