[PATCH] Doxygen docs for INI

[Dmitri Pal]

Hi,

Please find attached a patch that updates the ini_config.h to generate
doxygen docs.
I realized that it would be easier to push this out of the way and then
rework the other patch that I need to rework.
It would be simpler to rework it on top of this one then vice versa.
Thus sending this one.

[Stephen Gallagher]

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

On 03/15/2010 01:11 PM, Dmitri Pal wrote:
> Hi,
>
> Please find attached a patch that updates the ini_config.h to generate
> doxygen docs.
> I realized that it would be easier to push this out of the way and then
> rework the other patch that I need to rework.
> It would be simpler to rework it on top of this one then vice versa.
> Thus sending this one.

Ack to this patch. Please review my attached patch to include these docs
in the RPM package.

- -- 
Stephen Gallagher
RHCE 804006346421761

Delivering value year after year.
Red Hat ranks #1 in value among software vendors.
http://www.redhat.com/promo/vendor/
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.10 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/
>
> iEYEARECAAYFAkuedeUACgkQeiVVYja6o6N1NgCfdirOstt7EoGYj2NcFEIc0DDH
> JXMAnRleKawjItt8naspOKUAVTNoMbKD
> =ldyc
> -----END PGP SIGNATURE-----

[Dmitri Pal]

Stephen Gallagher wrote:
> On 03/15/2010 01:11 PM, Dmitri Pal wrote:
> > Hi,
> > Please find attached a patch that updates the ini_config.h to generate
> > doxygen docs.
> > I realized that it would be easier to push this out of the way and then
> > rework the other patch that I need to rework.
> > It would be simpler to rework it on top of this one then vice versa.
> > Thus sending this one.
>
> Ack to this patch. Please review my attached patch to include these docs
> in the RPM package.

I am not at all a spec expert but would the change:
-pushd common/collection
+pushd common

have some impact on the other directories under common that are not
documented yet or we have all the directories documented now?

I would have expected:
pushd common/collection
+pushd common/ini

rather then the one you have, but may be you are right...

[Stephen Gallagher]

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

On 03/15/2010 02:15 PM, Dmitri Pal wrote:
> Stephen Gallagher wrote:
> > On 03/15/2010 01:11 PM, Dmitri Pal wrote:
> > > Hi,
> > > Please find attached a patch that updates the ini_config.h to generate
> > > doxygen docs.
> > > I realized that it would be easier to push this out of the way and then
> > > rework the other patch that I need to rework.
> > > It would be simpler to rework it on top of this one then vice versa.
> > > Thus sending this one.
> >
> > Ack to this patch. Please review my attached patch to include these docs
> > in the RPM package.
>
> I am not at all a spec expert but would the change:
> -pushd common/collection
> +pushd common
>
> have some impact on the other directories under common that are not
> documented yet or we have all the directories documented now?
>
> I would have expected:
> pushd common/collection
> +pushd common/ini
>
> rather then the one you have, but may be you are right...

I actually did it wrong in the first place. In the Makefile.am for the
common directory, we have the DOCDIRS variable which specifies which
subdirectories to generate docs for. I updated that variable to include
ini, and I changed the pushd in the spec file to run it from the common
directory, instead of running it explicitly for both collection and ini.

- -- 
Stephen Gallagher
RHCE 804006346421761

Delivering value year after year.
Red Hat ranks #1 in value among software vendors.
http://www.redhat.com/promo/vendor/
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.10 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/
>
> iEYEARECAAYFAkueedIACgkQeiVVYja6o6N6zACglnhD2xYd50MXVMGelagAh0d1
> N+sAnRBENhPEId6iXrXiUGVjss/eeR2+
> =FzBZ
> -----END PGP SIGNATURE-----

[Dmitri Pal]

Stephen Gallagher wrote:
> On 03/15/2010 02:15 PM, Dmitri Pal wrote:
> > Stephen Gallagher wrote:
> > > On 03/15/2010 01:11 PM, Dmitri Pal wrote:
> > > > Hi,
> > > > Please find attached a patch that updates the ini_config.h to generate
> > > > doxygen docs.
> > > > I realized that it would be easier to push this out of the way and
>
> then
> > > > rework the other patch that I need to rework.
> > > > It would be simpler to rework it on top of this one then vice versa.
> > > > Thus sending this one.
> > >
> > > Ack to this patch. Please review my attached patch to include these
>
> docs
> > > in the RPM package.
> >
> > I am not at all a spec expert but would the change:
> > -pushd common/collection
> > +pushd common
> > have some impact on the other directories under common that are not
> > documented yet or we have all the directories documented now?
> > I would have expected:
> > pushd common/collection
> > +pushd common/ini
> > rather then the one you have, but may be you are right...
>
> I actually did it wrong in the first place. In the Makefile.am for the
> common directory, we have the DOCDIRS variable which specifies which
> subdirectories to generate docs for. I updated that variable to include
> ini, and I changed the pushd in the spec file to run it from the common
> directory, instead of running it explicitly for both collection and ini.

Ok I do not have any other comments but I can't be counted as authority.

_______________________________________________
sssd-devel mailing list
[e-mail]
https://fedorahosted.org/mailman/listinfo/sssd-devel

[Stephen Gallagher]

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

On 03/15/2010 02:31 PM, Dmitri Pal wrote:
> Stephen Gallagher wrote:
> > On 03/15/2010 02:15 PM, Dmitri Pal wrote:
> > > Stephen Gallagher wrote:
> > > > On 03/15/2010 01:11 PM, Dmitri Pal wrote:
> > > > > Hi,
> > > > > Please find attached a patch that updates the ini_config.h to generate
> > > > > doxygen docs.
> > > > > I realized that it would be easier to push this out of the way and
> >
> > then
> > > > > rework the other patch that I need to rework.
> > > > > It would be simpler to rework it on top of this one then vice versa.
> > > > > Thus sending this one.
> > > >
> > > > Ack to this patch. Please review my attached patch to include these
> >
> > docs
> > > > in the RPM package.
> > >
> > > I am not at all a spec expert but would the change:
> > > -pushd common/collection
> > > +pushd common
> > > have some impact on the other directories under common that are not
> > > documented yet or we have all the directories documented now?
> > > I would have expected:
> > > pushd common/collection
> > > +pushd common/ini
> > > rather then the one you have, but may be you are right...
> >
> > I actually did it wrong in the first place. In the Makefile.am for the
> > common directory, we have the DOCDIRS variable which specifies which
> > subdirectories to generate docs for. I updated that variable to include
> > ini, and I changed the pushd in the spec file to run it from the common
> > directory, instead of running it explicitly for both collection and ini.
>
> Ok I do not have any other comments but I can't be counted as authority.

Pushed both patches to master and 1-1-0

- -- 
Stephen Gallagher
RHCE 804006346421761

Delivering value year after year.
Red Hat ranks #1 in value among software vendors.
http://www.redhat.com/promo/vendor/
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.10 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/
>
> iEYEARECAAYFAkuelU4ACgkQeiVVYja6o6PkZwCfcviKjGpohcJEZV72VoSxeBVW
> DOgAnihC14VpbZnBOU52K/QeOSe4L7mE
> =RUtJ
> -----END PGP SIGNATURE-----