#448 Review API documentation
Closed: Invalid None Opened 14 years ago by obriend.

To check out the source:

git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
libtalloc-devel libtevent-devel libtdb-devel \
libldb-devel dbus-devel dbus-libs \
openldap-devel pam-devel nss-devel nspr-devel \
pcre-devel libxslt libxml2 docbook-style-xsl \
krb5-devel c-ares-devel python-devel check-devel \
doxygen libselinux-devel libsemanage-devel
cd sssd
./configure
make docs

The resulting docs will be in:
common/*/doc/html
src/doc/html

To make changes to the docs, you will need to edit the header files that
generated them. The generated HTML should have links pointing to the
correct source locations.


For clarity, since when I originally sent these instructions to David, I missed a key step:

git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
            libtalloc-devel libtevent-devel libtdb-devel \
            libldb-devel dbus-devel dbus-libs \
            openldap-devel pam-devel nss-devel nspr-devel \
            pcre-devel libxslt libxml2 docbook-style-xsl \
            krb5-devel c-ares-devel python-devel check-devel \
            doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

For clarity, since when I originally sent these instructions to David, I missed a key step:

git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
            libtalloc-devel libtevent-devel libtdb-devel \
            libldb-devel dbus-devel dbus-libs \
            openldap-devel pam-devel nss-devel nspr-devel \
            pcre-devel libxslt libxml2 docbook-style-xsl \
            krb5-devel c-ares-devel python-devel check-devel \
            doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

For clarity, since when I originally sent these instructions to David, I missed a key step:

git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
            libtalloc-devel libtevent-devel libtdb-devel \
            libldb-devel dbus-devel dbus-libs \
            openldap-devel pam-devel nss-devel nspr-devel \
            pcre-devel libxslt libxml2 docbook-style-xsl \
            krb5-devel c-ares-devel python-devel check-devel \
            doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

Replying to [comment:1 sgallagh]:

For clarity, since when I originally sent these instructions to David, I missed a key step:

{{{
git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
libtalloc-devel libtevent-devel libtdb-devel \
libldb-devel dbus-devel dbus-libs \
openldap-devel pam-devel nss-devel nspr-devel \
pcre-devel libxslt libxml2 docbook-style-xsl \
krb5-devel c-ares-devel python-devel check-devel \
doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs
}}}

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

Almost there...
running autoreconf -if as root in sssd/ I end up with the following:
libtoolize: copying file `m4/lt~obsolete.m4'
Can't exec "autopoint": No such file or directory at /usr/share/autoconf/Autom4te/FileUtils.pm line 345.
autoreconf: failed to run autopoint: No such file or directory
autoreconf: autopoint is needed because this package uses Gettext

I'm running all this on an up-to-date F12 VM.

Replying to [comment:1 sgallagh]:

For clarity, since when I originally sent these instructions to David, I missed a key step:

{{{
git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
libtalloc-devel libtevent-devel libtdb-devel \
libldb-devel dbus-devel dbus-libs \
openldap-devel pam-devel nss-devel nspr-devel \
pcre-devel libxslt libxml2 docbook-style-xsl \
krb5-devel c-ares-devel python-devel check-devel \
doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs
}}}

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

Almost there...
running autoreconf -if as root in sssd/ I end up with the following:
libtoolize: copying file `m4/lt~obsolete.m4'
Can't exec "autopoint": No such file or directory at /usr/share/autoconf/Autom4te/FileUtils.pm line 345.
autoreconf: failed to run autopoint: No such file or directory
autoreconf: autopoint is needed because this package uses Gettext

I'm running all this on an up-to-date F12 VM.

Replying to [comment:1 sgallagh]:

For clarity, since when I originally sent these instructions to David, I missed a key step:

{{{
git clone git://git.fedorahosted.org/sssd.git

To generate the HTML documentation (On Fedora 12/RHEL6):
yum install autoconf automake libtool m4 popt-devel \
libtalloc-devel libtevent-devel libtdb-devel \
libldb-devel dbus-devel dbus-libs \
openldap-devel pam-devel nss-devel nspr-devel \
pcre-devel libxslt libxml2 docbook-style-xsl \
krb5-devel c-ares-devel python-devel check-devel \
doxygen libselinux-devel libsemanage-devel
cd sssd
autoreconf -if
./configure
make docs
}}}

Please note, these instructions only work on Fedora >= 11. RHEL5 requires different dependency packages (they changed names) and also has a broken autoreconf (See Ticket #422)

Almost there...
running autoreconf -if as root in sssd/ I end up with the following:
libtoolize: copying file `m4/lt~obsolete.m4'
Can't exec "autopoint": No such file or directory at /usr/share/autoconf/Autom4te/FileUtils.pm line 345.
autoreconf: failed to run autopoint: No such file or directory
autoreconf: autopoint is needed because this package uses Gettext

I'm running all this on an up-to-date F12 VM.

Sorry, that yum command should also have included {{{gettext}}} {{{gettext-libs}}} and {{{gettext-devel}}}

Sorry, that yum command should also have included {{{gettext}}} {{{gettext-libs}}} and {{{gettext-devel}}}

Sorry, that yum command should also have included {{{gettext}}} {{{gettext-libs}}} and {{{gettext-devel}}}

Fields changed

milestone: NEEDS_TRIAGE => SSSD 1.2

Fields changed

milestone: NEEDS_TRIAGE => SSSD 1.2

Fields changed

milestone: NEEDS_TRIAGE => SSSD 1.2

Fields changed

milestone: SSSD 1.2 => SSSD 1.3

Fields changed

milestone: SSSD 1.2 => SSSD 1.3

Fields changed

milestone: SSSD 1.2 => SSSD 1.3

Fields changed

milestone: SSSD 1.5.0 => SSSD 1.6.0

Fields changed

milestone: SSSD 1.5.0 => SSSD 1.6.0

Fields changed

milestone: SSSD 1.5.0 => SSSD 1.6.0

Since the tools are being forked out this makes sense to do for the tools and the interfaces they will expose. This will be the best starting point. We can open tickets for other interfaces separately.

milestone: SSSD 1.6.0 => Tools 1.0

Since the tools are being forked out this makes sense to do for the tools and the interfaces they will expose. This will be the best starting point. We can open tickets for other interfaces separately.

milestone: SSSD 1.6.0 => Tools 1.0

Since the tools are being forked out this makes sense to do for the tools and the interfaces they will expose. This will be the best starting point. We can open tickets for other interfaces separately.

milestone: SSSD 1.6.0 => Tools 1.0

Fields changed

rhbz: => 0

Fields changed

rhbz: => 0

Fields changed

rhbz: => 0

Each interface needs to be reviewed separately.

blockedby: =>
blocking: =>
coverity: =>
feature_milestone: =>
milestone: Tools Backlog => Tools 1.0
patch: => 0
resolution: => wontfix
status: new => closed

Each interface needs to be reviewed separately.

blockedby: =>
blocking: =>
coverity: =>
feature_milestone: =>
milestone: Tools Backlog => Tools 1.0
patch: => 0
resolution: => wontfix
status: new => closed

Each interface needs to be reviewed separately.

blockedby: =>
blocking: =>
coverity: =>
feature_milestone: =>
milestone: Tools Backlog => Tools 1.0
patch: => 0
resolution: => wontfix
status: new => closed

Metadata Update from @obriend:
- Issue assigned to obriend
- Issue set to the milestone: Tools 1.0

7 years ago

SSSD is moving from Pagure to Github. This means that new issues and pull requests
will be accepted only in SSSD's github repository.

This issue has been cloned to Github and is available here:
- https://github.com/SSSD/sssd/issues/1490

If you want to receive further updates on the issue, please navigate to the github issue
and click on subscribe button.

Thank you for understanding. We apologize for all inconvenience.

Login to comment on this ticket.

Metadata