Skip Menu |
 

History Show all quoted text — Show full headers
# Mon May 02 14:46:58 2016 "Faladrin ." <faladrin@gmail.com> - Ticket created
Date: Mon, 2 May 2016 07:36:48 -0500
Subject: kinit documentation page
From: "Faladrin ." <faladrin@gmail.com>
To: krb5-bugs@mit.edu
Download (untitled) / with headers
text/plain 301B
Download (untitled) / with headers
text/html 480B
Hello,

On http://web.mit.edu/kerberos/krb5-1.12/doc/user/user_commands/kinit.html I don't see any documentation for the last optional parameter on the command "[principal]".  Given the command is knit perhaps this is obvious, but I'm not sure being obvious means it shouldn't be documented.

Thanks!
# Mon May 02 15:09:14 2016 ghudson@mit.edu (Greg Hudson) - Correspondence added
Download (untitled) / with headers
text/plain 133B
The description says "kinit obtains and caches an initial ticket-granting
ticket for _principal_". Do you think we should say more?
# Tue May 03 09:52:42 2016 "Faladrin ." <faladrin@gmail.com> - Correspondence added
Date: Tue, 3 May 2016 08:52:39 -0500
Subject: Re: [krbdev.mit.edu #8403] kinit documentation page
From: "Faladrin ." <faladrin@gmail.com>
To: rt-comment@krbdev.mit.edu, rt@krbdev.mit.edu
RT-Send-Cc:
Download (untitled) / with headers
text/plain 974B
Download (untitled) / with headers
text/html 1.2KiB
Perhaps not, but if you look at kpasswd it lists the principal option.  It could just as easily use the italic style on the word principal in its description and then mention the option as was done in the kinit doc.  This would be a trivial matter either way for the kpasswd page given the short length, but for kinit if for some reason I don't know what principal is and I go looking at the bottom of the list where I would expect it to appear given the read are in the order as presented in the syntax and then I don't find it, I'm a long way from the top where it is mentioned.  

Very minor overall as anyone looking at kinit should probably know what a principal is already, but I think consistency is slightly better served if it was listed.

On Mon, May 2, 2016 at 2:09 PM, Greg Hudson via RT <rt-comment@krbdev.mit.edu> wrote:
Show quoted text
The description says "kinit obtains and caches an initial ticket-granting
ticket for _principal_".  Do you think we should say more?

# Tue May 03 09:52:42 2016 "Faladrin ." <faladrin@gmail.com> - Comments added
Date: Tue, 3 May 2016 08:52:39 -0500
Subject: Re: [krbdev.mit.edu #8403] kinit documentation page
From: "Faladrin ." <faladrin@gmail.com>
To: rt-comment@krbdev.mit.edu, rt@krbdev.mit.edu
RT-Send-Cc:
Download (untitled) / with headers
text/plain 974B
Download (untitled) / with headers
text/html 1.2KiB
Perhaps not, but if you look at kpasswd it lists the principal option.  It could just as easily use the italic style on the word principal in its description and then mention the option as was done in the kinit doc.  This would be a trivial matter either way for the kpasswd page given the short length, but for kinit if for some reason I don't know what principal is and I go looking at the bottom of the list where I would expect it to appear given the read are in the order as presented in the syntax and then I don't find it, I'm a long way from the top where it is mentioned.  

Very minor overall as anyone looking at kinit should probably know what a principal is already, but I think consistency is slightly better served if it was listed.

On Mon, May 2, 2016 at 2:09 PM, Greg Hudson via RT <rt-comment@krbdev.mit.edu> wrote:
Show quoted text
The description says "kinit obtains and caches an initial ticket-granting
ticket for _principal_".  Do you think we should say more?

# Tue May 03 17:56:28 2016 tlyu (Taylor Yu) - Correspondence added
From: Tom Yu <tlyu@mit.edu>
To: rt@krbdev.mit.edu
Subject: Re: [krbdev.mit.edu #8403] kinit documentation page
Date: Tue, 03 May 2016 17:56:26 -0400
RT-Send-Cc:
Download (untitled) / with headers
text/plain 749B
I would consider the _principal_ argument of kinit to be an operand or a
non-option argument that can be omitted. It therefore belongs in the
"description" section. A brief check of a few Mac OS X and GNU manual
pages shows that arguments that can be omitted are typically documented
under "description" instead of "options".

The "option" terminology is typically meant for options that begin
with a '-' character and modify the behavior of the utility. See

http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap01.html#tag_17_04

for example.

I think the kpasswd documentation is somewhat nonstandard for putting
the argument under "Options". Perhaps we could add more text to the
"description" section to make it more prominent.
# Thu May 05 22:24:11 2016 "Faladrin ." <faladrin@gmail.com> - Comments added
Date: Thu, 5 May 2016 21:24:09 -0500
Subject: Re: [krbdev.mit.edu #8403] kinit documentation page
From: "Faladrin ." <faladrin@gmail.com>
To: rt-comment@krbdev.mit.edu, rt@krbdev.mit.edu
RT-Send-Cc:
Download (untitled) / with headers
text/plain 932B
Download (untitled) / with headers
text/html 1.4KiB
You seem quite correct.  Thank you for your time looking at this.

On Tue, May 3, 2016 at 4:56 PM, Tom Yu via RT <rt-comment@krbdev.mit.edu> wrote:
Show quoted text
I would consider the _principal_ argument of kinit to be an operand or a
non-option argument that can be omitted.  It therefore belongs in the
"description" section.  A brief check of a few Mac OS X and GNU manual
pages shows that arguments that can be omitted are typically documented
under "description" instead of "options".

The "option" terminology is typically meant for options that begin
with a '-' character and modify the behavior of the utility.  See

http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap01.html#tag_17_04

for example.

I think the kpasswd documentation is somewhat nonstandard for putting
the argument under "Options".  Perhaps we could add more text to the
"description" section to make it more prominent.


# Thu May 05 22:24:11 2016 "Faladrin ." <faladrin@gmail.com> - Correspondence added
Date: Thu, 5 May 2016 21:24:09 -0500
Subject: Re: [krbdev.mit.edu #8403] kinit documentation page
From: "Faladrin ." <faladrin@gmail.com>
To: rt-comment@krbdev.mit.edu, rt@krbdev.mit.edu
RT-Send-Cc:
Download (untitled) / with headers
text/plain 932B
Download (untitled) / with headers
text/html 1.4KiB
You seem quite correct.  Thank you for your time looking at this.

On Tue, May 3, 2016 at 4:56 PM, Tom Yu via RT <rt-comment@krbdev.mit.edu> wrote:
Show quoted text
I would consider the _principal_ argument of kinit to be an operand or a
non-option argument that can be omitted.  It therefore belongs in the
"description" section.  A brief check of a few Mac OS X and GNU manual
pages shows that arguments that can be omitted are typically documented
under "description" instead of "options".

The "option" terminology is typically meant for options that begin
with a '-' character and modify the behavior of the utility.  See

http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap01.html#tag_17_04

for example.

I think the kpasswd documentation is somewhat nonstandard for putting
the argument under "Options".  Perhaps we could add more text to the
"description" section to make it more prominent.


# Wed Sep 28 15:11:19 2016 tlyu (Taylor Yu) - Given to tlyu (Taylor Yu)
# Wed Sep 28 15:11:19 2016 tlyu (Taylor Yu) - Target_Version 1.14-next added
# Wed Sep 28 15:11:19 2016 tlyu (Taylor Yu) - Status changed from 'new' to 'review'
# Wed Sep 28 15:11:19 2016 tlyu (Taylor Yu) - Tags pullup added
# Wed Sep 28 15:11:19 2016 tlyu (Taylor Yu) - Correspondence added
From: tlyu@mit.edu
Subject: git commit
Download (untitled) / with headers
text/plain 395B

Clarify kinit principal selection

Describe the principal selection behavior of kinit when the principal
argument is absent.

https://github.com/krb5/krb5/commit/9896d4ffecb69f0262375b2f0db5b275a5e25de9
Author: Tom Yu <tlyu@mit.edu>
Commit: 9896d4ffecb69f0262375b2f0db5b275a5e25de9
Branch: master
doc/user/user_commands/kinit.rst | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
# Mon Oct 24 15:57:53 2016 tlyu (Taylor Yu) - Version_Fixed 1.14.5 added
# Mon Oct 24 15:57:53 2016 tlyu (Taylor Yu) - Correspondence added
From: tlyu@mit.edu
Subject: git commit
Download (untitled) / with headers
text/plain 468B

Clarify kinit principal selection

Describe the principal selection behavior of kinit when the principal
argument is absent.

(cherry picked from commit 9896d4ffecb69f0262375b2f0db5b275a5e25de9)

https://github.com/krb5/krb5/commit/2a50d753105df25076ace0a319fe321670655e2c
Author: Tom Yu <tlyu@mit.edu>
Commit: 2a50d753105df25076ace0a319fe321670655e2c
Branch: krb5-1.14
doc/user/user_commands/kinit.rst | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
# Mon Oct 24 17:07:47 2016 tlyu (Taylor Yu) - CustomField pullup deleted
# Mon Oct 24 17:12:39 2016 tlyu (Taylor Yu) - Status changed from 'review' to 'resolved'
# Mon Nov 14 16:55:03 2016 tlyu (Taylor Yu) - Version_Fixed 1.15 added