Git-Url: 
http://git.frugalware.org/gitweb/gitweb.cgi?p=frugalware-current.git;a=commitdiff;h=e5ac92723817e5e6a04343634ee78440069d1ad1

commit e5ac92723817e5e6a04343634ee78440069d1ad1
Author: Russell Dickenson (phayz) <russelldicken...@gmail.com>
Date:   Thu May 28 21:25:03 2009 +1000

Grammatical corrections to documentation

modified:   hotplug.txt
modified:   makepkg.txt
modified:   security.txt

diff --git a/docs/hotplug.txt b/docs/hotplug.txt
index 9728e62..7945b7e 100644
--- a/docs/hotplug.txt
+++ b/docs/hotplug.txt
@@ -4,8 +4,8 @@

The /dev directory under Frugalware is a ramdisk. Every device node is
created automatically during the system boot by the hotplug subsystem,
-more specifically, by udev. It means, there won't be unnecessary device
-nodes in /dev, but it also means, if you create a device node manually,
+more specifically, by udev. It means there won't be unnecessary device
+nodes in /dev, but it also means that if you create a device node manually,
it will exist only until the next shutdown/reboot.

If you want to force Frugalware to create a device node "manually" during each
@@ -17,30 +17,30 @@ Do not try to run udev on Frugalware with kernel series 
2.4.x.

== Pen/Thumbdrives

-Pendrives (also known as thumbdrives) are well-supported through the hotplug
-scripts and udev. If you insert a pendrive into the USB slot, udev will
-create a device node for it in /dev. Most pendrives contain only one
-partition and their filesystem is vfat. In most cases, the pendrive will
-behave like a SCSI disc. It means, you can find the pendrive
-under /dev/sda and its first partition under /dev/sda1.
+Pendrives (also known as thumbdrives, or USB keys) are well-supported
+through the hotplug scripts and udev. If you insert a pendrive into the
+USB slot, udev will create a device node for it in /dev. Most pendrives
+contain only one partition and their filesystem is vfat. In most cases,
+the pendrive will behave like a SCSI disc. It means, you can find the
+pendrive under /dev/sda and its first partition under /dev/sda1.
Adding the following line to /etc/fstab:

`/dev/sda1 /media/pendrive auto defaults,noauto,user 0 0`

-will allow users mount their pendrive if the device node
+will allow users to mount their pendrive if the device node
exists (if the device is inserted into the slot).

If you use KDE, Gnome or XFCE4 they will handle automatic mounting of
such devices. You should not edit /etc/fstab as automounting will not
work for you.
For blackbox, fluxbox, englightenment, e17  and other smaller window
-manager users there is `ivman` for automounting, but do not expect as
-fine work as in KDE, Gnome, XFCE4.
+manager users there is `ivman` for automounting, but it may not work as
+well as in KDE, Gnome, XFCE4.
See also the automounting part of the documentation.

== Digital cameras

-Tyipcally, there are two types of digital cameras. Some of them support
+Typically, there are two types of digital cameras. Some of them support
both access methods, others use only one of them. First, most of the
cameras can be treated as a pendrive (USB Mass Storage device), you can
mount them and copy the pictures from them easily.
@@ -66,6 +66,6 @@ If you want to change the default settings, all config files 
are
located in /etc/ivman. They are plain XML files, just read them,
everything is quite self-explanatory.

-Automounting also happens with KDE and Gnome, but their respective VFS
-implementation do that, not ivman. Ivman is useful for other windowing systems
+Automounting also happens with KDE and Gnome, but their respective VFS
+implementation does that, not ivman. Ivman is useful for other windowing 
systems
where is no support for such a feature.
diff --git a/docs/makepkg.txt b/docs/makepkg.txt
index 98e2584..7bcbec3 100644
--- a/docs/makepkg.txt
+++ b/docs/makepkg.txt
@@ -2,9 +2,9 @@

== Introduction

-Frugalware consists of thousands of packages. Each files in the distribution
-belong to some package. You can easily query which package does the specified
-file belong to. If you want to know which package contains
+Frugalware consists of thousands of packages. Each file in the distribution
+belongs to a package and you can easily query which package a file belongs.
+For example, if you want to know which package contains
'/etc/frugalware-release', you should use:

----------------------------------------------------
@@ -17,7 +17,7 @@ source directory there are category and category-extra dirs. 
The dirs without
-extra tag contains the basic packages of the given category and the
dependencies of the basic packages. So a package in these directories can not
depend on a package in extra directories.
-The same true for console/graphical applications: if your applications/library
+The same is true for console/graphical applications: if your 
application/library
is graphical, then use xapps/xlib, if not then use apps/lib.
For each task there is a default package. For example postfix is our
default MTA, so exim, sendmail, etc must be in some extra dir.
@@ -122,10 +122,10 @@ NOTE: If you are using stable, you probably want to use 
the `-t stable` option!

First we enter the directory of mplayer then (like make and Makefile)
we run makepkg that will build the package according to the parameters
-described in FrugalBuild. We used use the -R option to build the package
-in a chroot-ed environment. Since 0.5 building in chroot is the default
-methot, you have to use -H if you want to build on the host system.
-Chroot requires root privileges. To allow group (for example the devels
+described in FrugalBuild. We once had to use the -R option to build the package
+in a chroot-ed environment. Since 0.5, building in chroot is the default
+method, you have to use -H if you want to build on the host system.
+Chroot requires root privileges. To allow a group (for example the devels
group) to use sudo makepkg, start visudo as root, and add the following line:

`%devels ALL=NOPASSWD:/usr/bin/makepkg`
@@ -203,7 +203,7 @@ And here comes the description for each line:

`# Compiling Time: 0.06 SBU`

-You should write here how much time did it take to build the package.
+You should write here how much time it took to build the package.
Of course, it depends on your hardware, so we use SBUs instead of
minutes as a unit.

@@ -288,7 +288,7 @@ If it's not available, it means that gensync will skip it 
when generating
package databases. If you are not able to provide a binary package for a
given arch, don't include that in archs()! For example, no matter if the
package could be compiled in x86_64, if you haven't compiled it
-ourself, don't include it.
+yourself, don't include it.

---------------------------------------------------------------------------------
up2date="lynx -dump http://www.kyz.uklinux.net/cabextract.php |grep 'cabextract 
\
@@ -314,8 +314,8 @@ up2date="lynx -dump 
http://www.kyz.uklinux.net/cabextract.php |grep \

Here you define the sources of the package in a bash array.
You can use simple filenames for patches, or additional files
-when you place them in the same directory where the FrugalBuild
-script is. You can use URLs if you want makepkg to download them
+when you place them in the same directory as the FrugalBuild
+script. You can use URLs if you want makepkg to download them
automatically. It's important to place all sources in the package's
directory including the source files that you can download from a site.
Also when dowloading from sourceforge, please use Finclude sourceforge!
@@ -326,23 +326,23 @@ unless they are really necessary (eg: secfix, bugfix).

A few words about the size of the sources. If you use an URL then the size is
almost unlimited, but if the source is not an url then the source will be added
-to the FST when the package will be accepted. We don't allow files bigger than
-100KB in FST. To solve this problem, the sources for a given package are placed
+to the FST when the package is accepted. We don't allow files bigger than 100KB
+in FST. To solve this problem, the sources for a given package are placed
in the /pub/other/sources/pkgname dir for each package. If the source is not
-compressed, we use gzip or bzip2 to compess it first. After this one can use a
+compressed, we use gzip or bzip2 to compress it first. After this you can use a
`http://ftp.frugalware.org/pub/other/sources/pkgname/foo`-styled URL for those
big sources.

`sha1sums=(\'094e3afb2fe8dfe82f63731cdcd3b999f4856cff\')`

-Another bash array to prevent compiling from wrong sources. Of course this
- is useless if you just run sha1sum foo.tar.gz after download. Try fetching
- original sha1sums from the projects website, if possible. It's a good idea
- to leave a comment above this line about where to find these sha1sums.
+Another bash array to prevent compiling from the wrong source. Of course this
+is useless if you just run sha1sum foo.tar.gz after download. Try fetching
+original sha1sums from the projects website, if possible. It's a good idea
+to leave a comment above this line about where to find these sha1sums.

-As you can see there in no build() function in this FB. It's because we have
-wrote some F* functions to make our work easier. It's somethin similar you can
-see in gentoo for example. These functions can be found in 
'source/include/util.sh'
+As you can see there in no build() function in this FB. It's because we wrote
+some F* functions to make our work easier. It's something similar you can
+see in Gentoo for example. These functions can be found in 
'source/include/util.sh'
file inside the FST. An empty build actually means:

------------------------------------------------------------
@@ -370,7 +370,7 @@ each command, so the build will stop on error!
This line will be added automatically to the end of the FrugalBuild
if the build() function used your $CFLAGS or $CXXFLAGS. This is handy
if you want to cross-compile on a faster machine for a slower architecture.
-Until the package doesn't use our $CFLAGS we can't cross-compile it,
+If the package doesn't use our $CFLAGS we can't cross-compile it,
so please try to avoid creating "unoptimized" packages. If the package
doesn't contain any architecture-dependent file, then you can add this
line manually as makepkg will not detect this.
@@ -405,10 +405,10 @@ If possible, we don't modify config files during an 
upgrade. Example:
Note that the leading slash is missing!

For more information about this, see the handling config files section in the
-pacman-g2 manpage.
+pacman-g2 manpage

The depends array has been discussed already, except I haven't mentioned
- before that the elements may include version information, for example:
+before that the elements may include version information, for example:

-------------------------
pkgname=kdewebdev
@@ -421,8 +421,8 @@ The makedepends array defines packages required only in 
build time. For example
if the source is in SRPM format, probably alien is a build-time requirement.

The rodepends array defines packages required only in runtime. It must be
-used in any case when putting the given package to depends() would 
causecircular
-dependency.
+used in any case when putting the given package in the depends() array would
+cause circular dependency.

In the conflicts array, you can define a list of packages that shouldn't be
installed if you want to install this package. Let's see an another example:
@@ -432,9 +432,9 @@ pkgname=mutt-devel
conflicts=('mutt')
------------------

-It is necessary as the two package almost the same, but the binaries differs.
-In this case the mutt package must also contain this line: 
`conflicts=(\'mutt-devel\')`.
-Of course, if two or more packages conflict each other, only one of them can be
+It is necessary as the two packages are almost the same, but the binaries
+differ. In this case the mutt package must also contain this line:
+`conflicts=(\'mutt-devel\')`. Of course, if two or more packages conflict 
eachother, only one of them can be
placed in a non-extra group.

The provides array is used to create virtual dependencies. It means both
@@ -603,7 +603,7 @@ See `man kernel-module.sh` for more info.
Repoman is simple tool to download all packages' buildscript and compile
programs from source.

-The most commonly used repoman commands are the followings:
+The most commonly used repoman commands are the following:

`repoman merge package`

diff --git a/docs/security.txt b/docs/security.txt
index f2a8968..4822b9f 100644
--- a/docs/security.txt
+++ b/docs/security.txt
@@ -3,8 +3,7 @@
== Introduction

This document documents the work of the Frugalware Security Team. Primarily
-it's for new developers or for existing developers who started to work in the
-Security Team.
+it's for new developers or for existing developers who join the Security Team.

== Handling security bugs

@@ -15,8 +14,8 @@ fixing in -stable or not. If yes, then changes the status of 
the task to "Fixed
in -current", otherwise closes the task.

. If there is no patch for the issue yet, then set the status to "Researching".
-This indicates that you, the maintainer knows the problem, just you don't have
-enough resources to fix it.
+This indicates that you, the maintainer, is aware of the problem, but don't yet
+have enough a solution.

. The security team regularly searches for "Fixed in -current" bugs, fixes the
issue in -stable and releases a new FSA.
@@ -35,7 +34,7 @@ issue in -stable and releases a new FSA.
. Commit, push. The commit hook will check if the xml is valid, so most
common errors can be avoided. In rare cases, the announcement may not
appear on the frugalware-security list. If this is the case, then ask
-  on -devel about what the problem can be.
+  on -devel about what the problem might be.

. Close the task in the BTS, filing in FSAxxx in the closure message.

@@ -49,23 +48,26 @@ to notice issues.
. Open a task in BTS if necessary. Please fill in the form correctly, provide a
patch if you can.

-You can also read other mailing list, like
-https://lists.grok.org.uk/mailman/listinfo/full-disclosure, but secunia
+You can also read other mailing lists, like
+https://lists.grok.org.uk/mailman/listinfo/full-disclosure, but Secunia
monitors them, so you won't miss anything. (You just notice things later.)

== How to get patches

-Secunia announces sec issues days after they released so there is a good 
chance to find a patch.
+Secunia announces security issues days after they released so there is a good
+chance to find a patch.

. First of all sometimes upstream fixes it with a new version.
. Fixed in cvs/svn/whatever and you are able to find the patch (unlike PHP)
-. If these two fails, there is http://security.ubuntu.com/ubuntu/pool. Secunia
-also mails you if the bug fixen in ubuntu, so steal the patch from them :) You
-only need the $package-$pkgver.diff.gz. There is a changelog in it, where you
-can find the filename of the fix.
-. It's also a good idea to take a look on redhat/gentoo bugzilla. They attach 
fixes most the time.
+. If these two fail, there is http://security.ubuntu.com/ubuntu/pool. Secunia
+  also mails you if the bug fixen in Ubuntu, so steal the patch from them :) 
You
+  only need the $package-$pkgver.diff.gz. There is a changelog in it, where you
+  can find the filename of the fix.
+. It's also a good idea to take a look on RedHat/Gentoo bugzilla. They attach
+  fixes most the time.

-So it's good to read the secunia mails carefully as you'll always know when 
the patch is available.
+So it's good to read the Secunia mails carefully as you'll always know when the
+patch is available.

== Versioning

@@ -73,18 +75,17 @@ We use integers in pkgrels for normal packages, but -stable 
updates are
different. Here are the cases:

* If you do a version bump (we refer to them as 'secfix bump' usually in
-  -stable commit messages), then you need to set pkgrel to 1kalgan1.
+  -stable commit messages), then you need to set pkgrel to 
1<release_codename>1.

* If you add a security patch, and pkgrel was an integer (let's say '1'), then
-  you should increment pkgrel to 2kalgan1.
+  you should increment pkgrel to 2<release_codename>1.

-* If you add a security patch when the pkgrel was already in an XkalganY form,
-  increment it to XkalganY+1. (Alternatively, you can use X+1kalganY if there
-  is already a newer version in -current.)
+* If you add a security patch when the pkgrel was already in an
+  X<release_codename>Y form, increment it to X<release_codename>Y+1.
+  (Alternatively, you can use X+1<release_codename>Y if there is already a 
newer
+  version in -current.)

-(Replace kalgan with the current release name, later.)
-
-This ensures the followings:
+This ensures that:

* The version of the security update will be larger than the one in -stable, so
that the package will be upgraded when the user does a pacman-g2 -Syu on
_______________________________________________
Frugalware-git mailing list
Frugalware-git@frugalware.org
http://frugalware.org/mailman/listinfo/frugalware-git

Reply via email to