Bug 30203 - description of security profiles in FAQ is just plain wrong
Summary: description of security profiles in FAQ is just plain wrong
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-08-29 22:10 UTC by Michael W Lucas
Modified: 2001-08-31 17:30 UTC (History)
0 users

See Also:


Attachments
file.diff (6.68 KB, patch)
2001-08-29 22:10 UTC, Michael W Lucas
no flags Details | Diff
secprof.2 (4.71 KB, text/plain; charset=us-ascii)
2001-08-30 23:22 UTC, Michael W Lucas
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Michael W Lucas 2001-08-29 22:10:07 UTC
Robert Watson recently took an axe to the security profiles available
in sysinstall.  There are now only two profiles available, moderate &
extreme.

This is my first -doc patch prepared entirely from reading actual
source code, instead of from reading mailing lists.  As such, I'm
fully prepared to be told that I'm wrong.

I've also cleaned up a couple of sentences and corrected some grammar.
While I might be wrong on source code, I do know that using both a
colon and a semicolon in one sentence is ugly.

How-To-Repeat: 
read the source of sysinstall
Comment 1 dima 2001-08-30 11:00:25 UTC
mwlucas@blackhelicopters.org wrote:
> >Fix:
> 
> *** book.sgml-dist	Wed Aug 29 13:19:01 2001
> --- book.sgml	Wed Aug 29 13:44:25 2001
> ***************
> *** 2175,2229 ****
>           </question>
>   
>           <answer>
> !           <para>A <quote>security profile</quote> is a set of configuration
> !             options that attempts to achieve the desired ratio of security
> !             to convenience by enabling and disabling certain programs and
> !             other settings.  The more severe the security profile, the less
> !             programs will be enabled by default; this is one of the basic
> !             principles of security: do not run anything except what you
> !             must.</para>

Why did all these lines get replaced?  I can't tell what you changed
except for the last sentence.  Please try to minimize the amount of
lines changed to make reviewers' and translators' lives easier.  It's
okay if the resulting paragraph isn't filled (e.g., some lines are too
short, some overly long)--whoever commits it can fill it for you.

The same applies to some of the other paragraphs.  Other than that and
a few minor markup nits, this looks pretty good.  However, please
submit the updated version (fixing the problem my previous paragraph
describes) as a unified diff; that'd make it easier to read.

Thanks.
Comment 2 Michael W Lucas 2001-08-30 23:22:46 UTC
On Thu, Aug 30, 2001 at 03:00:25AM -0700, Dima Dorfman wrote:
> Why did all these lines get replaced?

Because my fingers are trained to automatically type esc-Q.  :)

Is this more like it?

-- 
Michael Lucas
mwlucas@blackhelicopters.org
http://www.blackhelicopters.org/~mwlucas/
Big Scary Daemons: http://www.oreillynet.com/pub/q/Big_Scary_Daemons
Comment 3 dima 2001-08-31 17:24:50 UTC
Michael Lucas <mwlucas@blackhelicopters.org> wrote:
> On Thu, Aug 30, 2001 at 03:00:25AM -0700, Dima Dorfman wrote:
> > Why did all these lines get replaced?
> 
> Because my fingers are trained to automatically type esc-Q.  :)
> 
> Is this more like it?

Yes.  I've applied it after fixing a few minor nits:

> --- book.sgml-dist	Thu Aug 30 11:10:07 2001
> +++ book.sgml-secprof	Thu Aug 30 11:10:03 2001
> @@ -2178,52 +2178,38 @@
...
> -          <para>Following is a table that describes what each security
> -            profile does.  The columns are the choices you have for a
> -            security profile, and the rows are the program or feature that
> -            is enabled or disabled.</para>
> +          <para>The following table describes what each of the
> +            security profiles does.  The columns are the choices you

"...what each of the security profiles does".  The verb (does) doesn't
agree in number with the subject (profiles).  Or something like
that--you get the idea.  I'm not an English teacher, so I probably got
the terms all wrong.  I changed 'does' to 'do'.

>                   <row>
>                     <entry></entry>
>  
>                     <entry>Extreme</entry>
>  
> -                   <entry>High</entry>
> -
>                     <entry>Moderate</entry>
>  
> -                   <entry>Low</entry>
>                   </row>

Excess vertical whitespace.  This ends up looking like:

	<entry>Moderate</entry>

      </row>

which is wrong.

There are some more caes of this below, which I've also fixed before
committing.

Thanks!
Comment 4 dd freebsd_committer freebsd_triage 2001-08-31 17:24:54 UTC
State Changed
From-To: open->closed

Patch committed, thanks!