Bug 201042

Summary:	Porters handbook section 7.6.10 could use more examples
Product:	Documentation	Reporter:	Johannes Jost Meixner <xmj>
Component:	Books & Articles	Assignee:	Mathieu Arnold <mat>
Status:	Closed Feedback Timeout
Severity:	Affects Only Me	CC:	doc
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description Johannes Jost Meixner freebsd_committer

2015-06-22 13:13:04 UTC

I've recently had a contributor look for ways how to set the mode of a directory, and he's working with the porter's handbook.

He found the keywords alright, but could not arrive at a good solution to his problem just by looking at the keywords in 7.6.10.

Could we have some examples (like the one in 7.10.6.1) around, so that it's perfectly clear how the keywords are to be used in specific cases?

Comment 1 Mathieu Arnold freebsd_committer

2015-06-30 20:45:28 UTC

Could you elaborate and provide some examples yourself so that I can see what's missing ?

Comment 2 Johannes Jost Meixner freebsd_committer

2015-07-01 02:38:50 UTC

Certainly!

In 7.6.10.1, there's this example:

[code]
@(,games,2755) sbin/daemon
[/code]

All others in the same section do not have any code blocks making it directly obvious how to do the appropriate @keyword command.

That leads to syntactical misunderstandings.

As in the present case, with

7.6.10.9. @dir directory

-- Basically, my idea would be to sprinkle examples all around section 7.6.10.

Comment 3 Mathieu Arnold freebsd_committer

2015-07-01 10:07:51 UTC

But, all keywords work the same, @<keyword> argument, with a possible owner/group/mode in between, if one reads 7.6, which is not long, he will understand what needs to be done.