Bug 145912
| Summary: | [patch] trivial enhancement patch for crontab(1) | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | jhs | ||||
| Component: | Books & Articles | Assignee: | Christian Brueffer <brueffer> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | CC: | jhs | ||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
jhs
2010-04-21 11:20:01 UTC
On Wed, Apr 21, 2010 at 3:12 AM, Julian H. Stacey <jhs@berklix.com> wrote: > ... > =A0.Bl -tag -width /var/cron/allow -compact > =A0.It Pa /var/cron/allow > =A0.It Pa /var/cron/deny > + .It Pa /var/cron/tabs/{login_names} Should {login_names} be removed because of the potential ambiguity that it introduces and be better defined through a description like with cron(8)? Also, there's no description of the proposed change in the bug report, so for someone that's trying to figure out what this change is doing from a customer perspective it would be nice if it said something like 'add a reference noting where the default installed crontabs are located', etc. Finally, this documentation kind of duplicates what's already in cron(8= ): The cron utility searches /var/cron/tabs for crontab files which are named after accounts in /etc/passwd; crontabs found are loaded into me= m- ory. The cron utility also searches for /etc/crontab which is in a di= f- ferent format (see crontab(5)). [...] FILES /etc/crontab System crontab file /etc/pam.d/cron pam.conf(5) configuration file for cron /var/cron/tabs Directory for personal crontab files Thanks, -Garrett Responsible Changed From-To: freebsd-bugs->freebsd-doc reclassify. > From: Garrett Cooper <yanefbsd@gmail.com> Garrett Cooper wrote: > On Wed, Apr 21, 2010 at 3:12 AM, Julian H. Stacey <jhs@berklix.com> wrote: > > > .Bl -tag -width /var/cron/allow -compact > > .It Pa /var/cron/allow > > .It Pa /var/cron/deny > > + .It Pa /var/cron/tabs/{login_names} > > Should {login_names} be removed It cant be removed because it does not exist to remove, until after my send-pr is commited. > because of the potential ambiguity > that it introduces What ambiguity ? > and be better defined through a description like > with cron(8)? Dont know what you mean. > Also, there's no description of the proposed change in > the bug report, so for someone that's trying to figure out what this > change is doing It's a proposal for a one line change to a manual ! > from a customer perspective it would be nice if it > said something like 'add a reference noting where the default > installed crontabs are located', etc. Yawn ! Add that comment to the send-pr if you want, pretty obvious. Any `customer' who cant figure what a one line diff to a manual does is a customer opinion I dont care about :-) > Finally, this documentation kind of duplicates what's already in cron(8): > > The cron utility searches /var/cron/tabs for crontab files which are > named after accounts in /etc/passwd; crontabs found are loaded into mem- > ory. The cron utility also searches for /etc/crontab which is in a dif- > ferent format (see crontab(5)). If you want, feel free to submit a send-pr for some wider consolidation of documentation, perhaps to move some tect from man cron to man crontab. > [...] > > FILES > /etc/crontab System crontab file > /etc/pam.d/cron pam.conf(5) configuration file for cron > /var/cron/tabs Directory for personal crontab files Cheers, Julian -- Julian Stacey: BSD Unix Linux C Sys Eng Consultants Munich http://berklix.com Mail plain text, Not HTML quoted-printable Base64 http://www.asciiribbon.org On Wed, Apr 21, 2010 at 6:38 AM, Julian H. Stacey <jhs@berklix.com> wrote: >> From: =A0 =A0 =A0 =A0 Garrett Cooper <yanefbsd@gmail.com> > > Garrett Cooper wrote: >> On Wed, Apr 21, 2010 at 3:12 AM, Julian H. Stacey <jhs@berklix.com> wrot= e: >> >> > =A0.Bl -tag -width /var/cron/allow -compact >> > =A0.It Pa /var/cron/allow >> > =A0.It Pa /var/cron/deny >> > + .It Pa /var/cron/tabs/{login_names} >> >> =A0 =A0 Should {login_names} be removed > > It cant be removed because it does not exist to remove, > until after my send-pr is commited. > > >> =A0because of the potential ambiguity >> that it introduces > > What ambiguity ? /var/cron/tabs/{login_names} -> ENOENT (does not exist). The entry should be consistent in cron(8) and say: /var/cron/tabs at least, no more. >> and be better defined through a description like >> with cron(8)? > > Dont know what you mean. FILE DESCRIPTION /etc/crontab System crontab file /etc/pam.d/cron pam.conf(5) configuration file for cron /var/cron/tabs Directory for personal crontab files The files should be keyed pairs. This is an inconsistency in the documentation that should be corrected. > >> Also, there's no description of the proposed change in >> the bug report, so for someone that's trying to figure out what this >> change is doing > > It's a proposal for a one line change to a manual ! Yes, and if we're going to change this now, we might as well make it a three line change to be consistent with cron(8) :)... >> from a customer perspective it would be nice if it >> said something like 'add a reference noting where the default >> installed crontabs are located', etc. > > > Yawn ! =A0Add that comment to the send-pr if you want, pretty obvious. > Any `customer' who cant figure what a one line diff to a manual > does is a customer opinion I dont care about :-) Posting to bug-followup already did that. >> =A0 =A0 Finally, this documentation kind of duplicates what's already in= cron(8): >> >> =A0 =A0 =A0The cron utility searches /var/cron/tabs for crontab files wh= ich are >> =A0 =A0 =A0named after accounts in /etc/passwd; crontabs found are loade= d into mem- >> =A0 =A0 =A0ory. =A0The cron utility also searches for /etc/crontab which= is in a dif- >> =A0 =A0 =A0ferent format (see crontab(5)). > > If you want, feel free to submit a send-pr for some wider consolidation > of documentation, perhaps to move some tect from man cron to man crontab. Perhaps, but again... the details need to be logically consolidated. Some entries are best kept in crontab(5) (like your proposed addition, plus the description for it that's missing, and the reference to /etc/crontab), and other pieces should be in cron(8) (like /etc/pam.d/cron). If you don't want to provide the patch then I will make the modification and post it ... inconsistent documentation leads to user confusion which doesn't help the overall goal trying to be achieved in having the documentation in the first place :). >> [...] >> >> FILES >> =A0 =A0 =A0/etc/crontab =A0 =A0 System crontab file >> =A0 =A0 =A0/etc/pam.d/cron =A0pam.conf(5) configuration file for cron >> =A0 =A0 =A0/var/cron/tabs =A0 Directory for personal crontab files Thanks, -Garrett Hi, Reference: > From: Garrett Cooper <yanefbsd@gmail.com> > Date: Wed, 21 Apr 2010 09:47:35 -0700 > Message-id: <j2k7d6fde3d1004210947h7df71d8ar192fedbd74152d23@mail.gmail.com> Garrett Cooper wrote: > On Wed, Apr 21, 2010 at 6:38 AM, Julian H. Stacey <jhs@berklix.com> wrote: > >> From: Garrett Cooper <yanefbsd@gmail.com> > > > > Garrett Cooper wrote: > >> On Wed, Apr 21, 2010 at 3:12 AM, Julian H. Stacey <jhs@berklix.com> wrote: > >> > >> > .Bl -tag -width /var/cron/allow -compact > >> > .It Pa /var/cron/allow > >> > .It Pa /var/cron/deny > >> > + .It Pa /var/cron/tabs/{login_names} > >> > >> Should {login_names} be removed > > > > It cant be removed because it does not exist to remove, > > until after my send-pr is commited. > > > > > >> because of the potential ambiguity > >> that it introduces > > > > What ambiguity ? > > /var/cron/tabs/{login_names} -> ENOENT (does not exist). > > The entry should be consistent in cron(8) and say: > > /var/cron/tabs > > at least, no more. OK, accepted. Possibly with a terminal slash ? eg /var/cron/tabs ? There's perhaps a style standard on omitting or appending '/' after "tabs" so I won't express opinion either way, whatever a committer chooses. > >> and be better defined through a description like > >> with cron(8)? > > > > Dont know what you mean. > > FILE DESCRIPTION > > /etc/crontab System crontab file > /etc/pam.d/cron pam.conf(5) configuration file for cron > /var/cron/tabs Directory for personal crontab files > > The files should be keyed pairs. This is an inconsistency in the > documentation that should be corrected. OK. (dont need a terminal '/' if we have description :-) > >> Also, there's no description of the proposed change in > >> the bug report, so for someone that's trying to figure out what this > >> change is doing > > > > It's a proposal for a one line change to a manual ! > > Yes, and if we're going to change this now, we might as well make it a > three line change to be consistent with cron(8) :)... /usr/bin/crontab does not edit /etc/crontab, so better mention /etc/crontab under SEE ALSO, not under FILES > >> from a customer perspective it would be nice if it > >> said something like 'add a reference noting where the default > >> installed crontabs are located', etc. > > > > > > Yawn ! Add that comment to the send-pr if you want, pretty obvious. > > Any `customer' who cant figure what a one line diff to a manual > > does is a customer opinion I dont care about :-) > > Posting to bug-followup already did that. OK > >> Finally, this documentation kind of duplicates what's already in cron(8): > >> > >> The cron utility searches /var/cron/tabs for crontab files which are > >> named after accounts in /etc/passwd; crontabs found are loaded into mem- > >> ory. The cron utility also searches for /etc/crontab which is in a dif- > >> ferent format (see crontab(5)). > > > > If you want, feel free to submit a send-pr for some wider consolidation > > of documentation, perhaps to move some tect from man cron to man crontab. > > Perhaps, but again... the details need to be logically consolidated. > Some entries are best kept in crontab(5) (like your proposed addition, > plus the description for it that's missing, and the reference to > /etc/crontab), and other pieces should be in cron(8) (like > /etc/pam.d/cron). > > If you don't want to provide the patch then I will make the > modification and post it ... inconsistent documentation leads to user > confusion which doesn't help the overall goal trying to be achieved in > having the documentation in the first place :). Well uou spotted more than me, so please post. > >> [...] > >> > >> FILES > >> /etc/crontab System crontab file > >> /etc/pam.d/cron pam.conf(5) configuration file for cron > >> /var/cron/tabs Directory for personal crontab files > > Thanks, > -Garrett Cheers, Julian -- Julian Stacey: BSD Unix Linux C Sys Eng Consultants Munich http://berklix.com Mail plain text, Not HTML quoted-printable Base64 http://www.asciiribbon.org State Changed From-To: open->patched Added the entries and additional descriptions. Thanks! Responsible Changed From-To: freebsd-doc->brueffer MFC reminder. Author: brueffer Date: Fri May 14 01:25:30 2010 New Revision: 208054 URL: http://svn.freebsd.org/changeset/base/208054 Log: List /var/cron/tabs in FILES and add descriptions for the other entries. PR: 145912 Submitted by: Julian H. Stacey <jhs@berklix.com> Obtained from: OpenBSD MFC after: 1 week Modified: head/usr.sbin/cron/crontab/crontab.1 Modified: head/usr.sbin/cron/crontab/crontab.1 ============================================================================== --- head/usr.sbin/cron/crontab/crontab.1 Fri May 14 01:10:20 2010 (r208053) +++ head/usr.sbin/cron/crontab/crontab.1 Fri May 14 01:25:30 2010 (r208054) @@ -17,7 +17,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 29, 1993 +.Dd May 13, 2010 .Dt CRONTAB 1 .Os .Sh NAME @@ -114,7 +114,11 @@ from the editor, the modified crontab wi .Sh FILES .Bl -tag -width /var/cron/allow -compact .It Pa /var/cron/allow +List of users allowed to use crontab .It Pa /var/cron/deny +List of users prohibited from using crontab +.It Pa /var/cron/tabs +Directory for personal crontab files .El .Sh DIAGNOSTICS A fairly informative usage message appears if you run it with a bad command _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org" State Changed From-To: patched->closed MFCs done. |
