[PATCH] MAN: libkrb5 and SSSD use different expansions

[Pavel Reichl]

Hello, please see attached patch. Thanks!

[Pavel Reichl]

On 01/14/2015 06:16 PM, Pavel Reichl wrote:
> Hello, please see attached patch. Thanks!
>
> sssd-devel mailing list
> [e-mail]
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel

Should I ask some native speaker for review or shall we do the review 
ourselves?

[Jakub Hrozek]

On Wed, Jan 28, 2015 at 03:23:09PM +0100, Pavel Reichl wrote:
> On 01/14/2015 06:16 PM, Pavel Reichl wrote:
> > Hello, please see attached patch. Thanks!
> >
> > sssd-devel mailing list
> > [e-mail]
> > https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
>
> Should I ask some native speaker for review or shall we do the review
> ourselves?

It would be nice if Stephen or Dan could help.

[Dan Lavu]

Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.

Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.

----- Original Message -----
From: "Jakub Hrozek" 
To: [e-mail]
Sent: Wednesday, January 28, 2015 9:28:25 AM
Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions

On Wed, Jan 28, 2015 at 03:23:09PM +0100, Pavel Reichl wrote:
> On 01/14/2015 06:16 PM, Pavel Reichl wrote:
> > Hello, please see attached patch. Thanks!
> >
> > sssd-devel mailing list
> > [e-mail]
> > https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
>
> Should I ask some native speaker for review or shall we do the review
> ourselves?

It would be nice if Stephen or Dan could help.
_______________________________________________
sssd-devel mailing list
[e-mail]
https://lists.fedorahosted.org/mailman/listinfo/sssd-devel

[Sumit Bose]

On Fri, Jan 30, 2015 at 05:22:53AM -0500, Dan Lavu wrote:
> Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
>
> Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.

the tools are called xmllint and xsltproc but instead of running them
manually I would suggest to let make do this for you:

$ touch ../src/man/sssd-krb5.5.xml
$ make V=0 man_MANS=sssd-krb5.5                                                                                                                                                                    
make  all-recursive
make[1]: Entering directory '/home/sbose/sssd/master_build'
Making all in po
make[2]: Entering directory '/home/sbose/sssd/master_build/po'
make[2]: Nothing to be done for 'all'.
make[2]: Leaving directory '/home/sbose/sssd/master_build/po'
Making all in src/man
make[2]: Entering directory '/home/sbose/sssd/master_build/src/man'
/usr/bin/xmllint --catalogs --postvalid --nonet --noent --xinclude --noout ../../../src/man/sssd-krb5.5.xml
/usr/bin/xsltproc -o sssd-krb5.5  --catalogs --xinclude --nonet --stringparam profile.condition "with_false;with_sudo;with_autofs;with_ssh;with_pac_responder;with_ifp" http://docbook.sourceforge.net/release/xsl/current/manpages/profile-docbook.... ../../../src/man/sssd-krb5.5.xml
Note: Writing sssd-krb5.5

....
[dropped some addtional output]
...

$ man src/man/sssd-krb5.5

Here you can also see the xmllint and xsltproc option used to generate the man page.

HTH

bye,
Sumit
> ----- Original Message -----
> From: "Jakub Hrozek" 
> To: [e-mail]
> Sent: Wednesday, January 28, 2015 9:28:25 AM
> Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions
>
> On Wed, Jan 28, 2015 at 03:23:09PM +0100, Pavel Reichl wrote:
> > On 01/14/2015 06:16 PM, Pavel Reichl wrote:
> > > Hello, please see attached patch. Thanks!
> > >
> > > sssd-devel mailing list
> > > [e-mail]
> > > https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
> >
> > Should I ask some native speaker for review or shall we do the review
> > ourselves?
>
> It would be nice if Stephen or Dan could help.
> _______________________________________________
> sssd-devel mailing list
> [e-mail]
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
> diff --git a/src/man/sssd-krb5.5.xml b/src/man/sssd-krb5.5.xml
> index 5bcab21..ad6389b 100644
> --- a/src/man/sssd-krb5.5.xml
> +++ b/src/man/sssd-krb5.5.xml
> @@ -215,14 +215,34 @@
>                          <para>
>                              The default value for the credential cache name is
>                              sourced from the profile stored in the system wide
>                        krb5.conf configuration file in the [libdefaults]
>                        krb5.conf configuration file, in the [libdefaults]
>                        section. The option name is default_ccache_name.
>                        See krb5.conf(5)'s PARAMETER EXPANSION paragraph
>                        for additional information on the expansion format
>                        defined by krb5.conf.
>                    </para>
>                    <para>
>                        Default: (from libkrb5)
>                        NOTE: The value for the template is not the same
>                        between sssd.conf and
>                      <citerefentry>
>                            <refentrytitle>krb5.conf</refentrytitle>
>                            <manvolnum>5</manvolnum>
>                      </citerefentry>
>                    </para>
>                    <para>
>                        The equivalent values are listed below.
>                      <variablelist>
>                            <varlistentry>
>                                <term>krb5.conf</term>
>                                <listitem><para>KEYRING:persistent:%{uid}
>                                                </para></listitem>
>                            </varlistentry>
>                            <varlistentry>
>                                <term>sssd.conf</term>
>                                <listitem><para>KEYRING:persistent:%U
>                                                </para></listitem>
>                            </varlistentry>
>                      </variablelist>
>                    </para>
>                </listitem>
>            </varlistentry>
> sssd-devel mailing list
> [e-mail]
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel

[Pavel Reichl]

On 01/30/2015 11:22 AM, Dan Lavu wrote:
> Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
>
> Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.

Hello Dan,

first of all thanks for the proposed changes.  As I'm no expert at 
configuring kerberos I let somebody else do the review.

I'm personally not sure about:

+                            NOTE: The value for the template is not the 
same

because IMO there are more template values that differ between sssd.conf 
and krb5.conf.
for example krb5.conf uses "%{username}" but sssd uses "%u" for user name.

I'm also not very sure about listing of equivalent values as the list 
AFAIK is not complete and could imply that non listed options are the 
same for both configuration files.

I reformatted and attached your patch (kept you as author) to match the 
format we usually use.

If you are interested in creating patches in our preferred format (so 
the patches can be applied by 'git am') then please follow these steps:
1) call 'git add' on your modified files
2) call git commit and enter commit message based on this template:
COMPONENT: Subject

Explanation

Resolves:
https://fedorahosted.org/sssd/ticket/XXXX

3) generate the patch:  git format-patch -M -C --patience --full-index -1

Please note it's perfectly OK to propose changes without sending patch 
yourself.

Thanks and please feel free to ping me with any question regarding our 
contribution process.
> ----- Original Message -----
> From: "Jakub Hrozek" 
> To: [e-mail]
> Sent: Wednesday, January 28, 2015 9:28:25 AM
> Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions
>
> On Wed, Jan 28, 2015 at 03:23:09PM +0100, Pavel Reichl wrote:
> > On 01/14/2015 06:16 PM, Pavel Reichl wrote:
> > > Hello, please see attached patch. Thanks!
> > >
> > > sssd-devel mailing list
> > > [e-mail]
> > > https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
> >
> > Should I ask some native speaker for review or shall we do the review
> > ourselves?
>
> It would be nice if Stephen or Dan could help.
> _______________________________________________
> sssd-devel mailing list
> [e-mail]
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
>
> sssd-devel mailing list
> [e-mail]
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel

[Pavel Reichl]

On 02/09/2015 11:46 AM, Pavel Reichl wrote:
> On 01/30/2015 11:22 AM, Dan Lavu wrote:
> > Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
> >
> > Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.
>
> Hello Dan,
>
> first of all thanks for the proposed changes.  As I'm no expert at 
> configuring kerberos I let somebody else do the review.

Dan agrees that it would be helpful if somebody else could have a look.

Thanks.

[Jakub Hrozek]

On Mon, Mar 09, 2015 at 04:51:48PM +0100, Pavel Reichl wrote:
> On 02/09/2015 11:46 AM, Pavel Reichl wrote:
> > On 01/30/2015 11:22 AM, Dan Lavu wrote:
> > > Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
> > >
> > > Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.
> >
> > Hello Dan,
> >
> > first of all thanks for the proposed changes.  As I'm no expert at
> > configuring kerberos I let somebody else do the review.
>
> Dan agrees that it would be helpful if somebody else could have a look.
>
> Thanks.

I agree with you that we shouldn't list what differs, just state the
template might be different, otherwise the list of differences will be
incomplete.

I like your first patch - ACK from me. I will wait until tomorrow before
pushing to see if someone has any comments.

[Jakub Hrozek]

On Tue, Mar 10, 2015 at 02:53:17PM +0100, Jakub Hrozek wrote:
> On Mon, Mar 09, 2015 at 04:51:48PM +0100, Pavel Reichl wrote:
> > On 02/09/2015 11:46 AM, Pavel Reichl wrote:
> > > On 01/30/2015 11:22 AM, Dan Lavu wrote:
> > > > Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
> > > >
> > > > Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.
> > >
> > > Hello Dan,
> > >
> > > first of all thanks for the proposed changes.  As I'm no expert at
> > > configuring kerberos I let somebody else do the review.
> >
> > Dan agrees that it would be helpful if somebody else could have a look.
> >
> > Thanks.
>
> I agree with you that we shouldn't list what differs, just state the
> template might be different, otherwise the list of differences will be
> incomplete.
>
> I like your first patch - ACK from me. I will wait until tomorrow before
> pushing to see if someone has any comments.

* master: 33b8bf140b1d82d2626eeeaaea29af49dcdb3c99

[Jakub Hrozek]

On Fri, Mar 13, 2015 at 09:22:04AM +0100, Jakub Hrozek wrote:
> On Tue, Mar 10, 2015 at 02:53:17PM +0100, Jakub Hrozek wrote:
> > On Mon, Mar 09, 2015 at 04:51:48PM +0100, Pavel Reichl wrote:
> > > On 02/09/2015 11:46 AM, Pavel Reichl wrote:
> > > > On 01/30/2015 11:22 AM, Dan Lavu wrote:
> > > > > Oooof... I tried digest mode so I can get a better overview of all the mailing lists I'm on and I found it more cumbersome. Anyways, here is my edit.
> > > > >
> > > > > Also does anybody know of a tool, so I can test the xml for errors and view the output like a man page? Without compiling the book? Thanks.
> > > >
> > > > Hello Dan,
> > > >
> > > > first of all thanks for the proposed changes.  As I'm no expert at
> > > > configuring kerberos I let somebody else do the review.
> > >
> > > Dan agrees that it would be helpful if somebody else could have a look.
> > >
> > > Thanks.
> >
> > I agree with you that we shouldn't list what differs, just state the
> > template might be different, otherwise the list of differences will be
> > incomplete.
> >
> > I like your first patch - ACK from me. I will wait until tomorrow before
> > pushing to see if someone has any comments.
> master: 33b8bf140b1d82d2626eeeaaea29af49dcdb3c99

* sssd-1-12: e66ff0a610aa9342f16e61018963b2c7f1d60812

[Roland Mainz]

----- Original Message -----
> From: "Dan Lavu" 
> To: "Development of the System Security Services Daemon" 
> Sent: Friday, January 30, 2015 11:22:53 AM
> Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions
>
> Oooof... I tried digest mode so I can get a better overview of all the
> mailing lists I'm on and I found it more cumbersome. Anyways, here is my
> edit.

Two minor nits:
1. Filenames like krb5.conf or sssd.conf should be placed into <filename>krb5.conf</filename> (see http://docbook.org/tdg/en/html/filename.html).
2. If you reference a manpage like krb5.conf(5) it should be done via <citerefentry><refentrytitle>krb5.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> (basic idea is that DocBook-->PDF or DocBook-->HTML conversions turn this into hyperlinks)

----

Bye,
Roland

[Dan Lavu]

Besides the two minor nits, the content is okay?

----- Original Message -----

From: "Roland Mainz"  
To: "Development of the System Security Services Daemon"  
Sent: Thursday, February 12, 2015 12:16:44 PM 
Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions

----- Original Message -----
> From: "Dan Lavu"  
> To: "Development of the System Security Services Daemon"  
> Sent: Friday, January 30, 2015 11:22:53 AM 
> Subject: Re: [SSSD] [PATCH] MAN: libkrb5 and SSSD use different expansions
>
> Oooof... I tried digest mode so I can get a better overview of all the 
> mailing lists I'm on and I found it more cumbersome. Anyways, here is my 
> edit.

Two minor nits: 
1. Filenames like krb5.conf or sssd.conf should be placed into <filename>krb5.conf</filename> (see http://docbook.org/tdg/en/html/filename.html). 
2. If you reference a manpage like krb5.conf(5) it should be done via <citerefentry><refentrytitle>krb5.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> (basic idea is that DocBook-->PDF or DocBook-->HTML conversions turn this into hyperlinks)

----

Bye, 
Roland