[meta-freescale] [Documentation][PATCH] Some grammar edits for FSL Community FAQ

Bob Cochran yocto at mindchasers.com
Sun Nov 2 18:27:18 PST 2014 

Signed-off-by: Bob Cochran <yocto at mindchasers.com>
---
 FAQ/source/all.rst   |   99 +++++++++++++++++++++++++-------------------------
 FAQ/source/index.rst |    2 +-
 2 files changed, 50 insertions(+), 51 deletions(-)

diff --git a/FAQ/source/all.rst b/FAQ/source/all.rst
index 586e7e9..0d0cae9 100644
--- a/FAQ/source/all.rst
+++ b/FAQ/source/all.rst
@@ -1,37 +1,36 @@
 How can I contribute to the project?
 ------------------------------------
 
-* Subscribe to the `list <http://freescale.github.io/#contributing>`_
-* Check the ``README`` file of the layer you are trying to patch, it has the 
-  steps to start contributing. In resume, create your commits locally, 
+* Subscribe to the `mailing list <http://freescale.github.io/#contributing>`_
+* Check the ``README`` file of the layer you are trying to patch. It lists the
+  steps to start contributing. To summarize: create your commits locally,
   format them into patches (``git format-patch``) and send them to the 
   list (``git send-email``)
 
 How can I build an image?
 -------------------------
 
-Steps are detailed on `fsl-community-bsp-platform <https://github.com/Freescale/fsl-community-bsp-platform>`_ repository.
+Steps are detailed here: `fsl-community-bsp-platform <https://github.com/Freescale/fsl-community-bsp-platform>`_
 
 
 Bitbake encountered an error, what can I do?
 --------------------------------------------
 
-A final answer can not be given due to the full range of possible errors. Some suggestions:
+A single answer can not be given due to the full range of possible errors. However, here are some suggestions:
 
-* Check on the mailing list if this error has been reported
-* Clean-State the recipe raising the problem: ``bitbake -c cleansstate $PN`` where ``PN``
-  is the recipe's name.
-* Check the log carefully and look at ``log`` files pointed by ``bitbake``
+* Check the mailing list to see if this error has been previously reported
+* Clean-State the recipe that raised the error: ``bitbake -c cleansstate <PN>`` where ``PN`` is the recipe's name
+* Check the log carefully by looking at the ``log`` files listed by the output from ``bitbake``
 
 
-Which packages are included on an images?
+Which packages are included in an image?
 -----------------------------------------------
 
-Generate the `dot` file and filter native packages::
+Generate the `dot` file and filter out the native packages:
 
-    $ bitbake -g <image name> && cat pn-depends.dot | grep -v 'native'
+    $ bitbake -g <image-name> && cat pn-depends.dot | grep -v 'native' | more
 
-where ``<image name>`` is the name of the image you are building, i.e. ``core-image-minimal``
+where ``<image-name>`` is the name of the image you are building, i.e. ``core-image-minimal``
 
 
 Which packages are available to be installed?
@@ -39,7 +38,7 @@ Which packages are available to be installed?
 
 Use the ``bitbake-layers`` script::
 
-    $ bitbake-layers show-recipes
+    $ bitbake-layers show-recipes | more
 
 
 Which layers do I have configured?
@@ -49,97 +48,97 @@ Use the ``bitbake-layers`` script::
     
     $ bitbake-layers show-layers
 
-How do I add a package into an image?
+How do I add a package to an image?
 -------------------------------------
 
-Two ways:
+Two of the ways are:
 
-* Append ``IMAGE_INSTALL_append = " package-name-1 package-name-2 ..."`` into your 
-  ``local.conf`` file. Just make sure there is a space as the beginning!
+* Add ``IMAGE_INSTALL_append = " package-name-1 package-name-2 ..."`` to your
+  ``local.conf`` file. Make sure there is a space after the opening quote '"'!
 
-* Append ``CORE_IMAGE_EXTRA_INSTALL = "package-name-1 package-name-2 ..."`` into your
-  ``local.conf`` file
+* Add ``CORE_IMAGE_EXTRA_INSTALL = "package-name-1 package-name-2 ..."`` to your ``local.conf`` file
 
 
-How can I build an image containing mainline Linux Kernel?
-----------------------------------------------------------
+How can I build an image containing the mainline Linux Kernel?
+--------------------------------------------------------------
 
-* Append ``PREFERRED_PROVIDER_virtual/kernel = "linux-fslc"`` on your ``local.conf``
+* Add ``PREFERRED_PROVIDER_virtual/kernel = "linux-fslc"`` to your ``local.conf``
   file.
 
-* Clean the Kernel's provider and bake the image again::
+* Clean the kernel's provider (state) and bake the image again::
 
     $ bitbake -c cleansstate virtual/kernel
     $ bitbake $IMAGE_NAME
 
-How can I switch to Soft Floating-Point?
+How can I switch to Soft Floating Point?
 ----------------------------------------
 
-By default, the system is configure as Hard Float-Point, so to change to Soft Float-Point,
-append ``DEFAULTTUNE_mx6 = "cortexa9-neon"`` to your ``local.conf`` file (or machine file).
+By default, the system is configured for hard floating point. To change to soft floating point,
+add ``DEFAULTTUNE_mx6 = "cortexa9-neon"`` to your ``local.conf`` file (or machine file).
 
 How do I enable Chromiun?
 -------------------------
 
+To be added
+
 How do I enable QT5.2?
 ----------------------
 
-How can I modify source code and compile?
------------------------------------------
+To be added
+
+How can I modify source code and compile it?
+--------------------------------------------
 
-* Do any code change under the corresponding `tmp/work <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#finding-the-temporary-source-code>`_ folder
+* Make your source code changes in the appropriate `tmp/work <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#finding-the-temporary-source-code>`_ folder
 
-* Force compiling and build::
+* Force compilation and (re)build::
 
     $ bitbake -c compile -f <recipe name>
     $ bitbake <recipe name>
 
-  where ``<recipe name>`` is the name of the recipe involved.
-
 How can I create a patch?
 -------------------------
 
-Yocto was not intended as a package development framework but in case you need to patch 
-a recipe, follow `the Kernel patching <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#patching-the-kernel>`_ guide. For Yocto Project, the Kernel is like any
-other recipe, so this guide can be applied to any recipe.
+Yocto was not intended to be a package development framework, but in case you need to patch
+a recipe, follow the `kernel patching guide <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#patching-the-kernel>`_ . For the Yocto Project, the kernel is like any other recipe, so this guide can be applied to any recipe.
 
 How do I create a layer?
 ------------------------
 
-* Create the layer with the ``yocto-layer`` script::
+* Create the new layer with the ``yocto-layer`` script::
 
-    $ yocto-layer create <layer name>
+    $ yocto-layer create <layer-name>
 
-  where ``layer name`` is the name of the layer you want, resulting in ``meta-<layer name>``.
+  where ``layer-name`` is the name of the layer you want to create.
 
-* Enable your `layer <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#enabling-your-layer>`_
+* `Enable <http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#enabling-your-layer>`_ your layer
 
-What are the host's packages needed for Yocto Project?
+What are the host packages needed for Yocto Project?
 ------------------------------------------------------
 
-* Make sure your Linux Host is `supported <http://www.yoctoproject.org/docs/1.5.1/ref-manual/ref-manual.html#detailed-supported-distros>`_
+* Make sure your Linux host / distribution is `supported <http://www.yoctoproject.org/docs/1.5.1/ref-manual/ref-manual.html#detailed-supported-distros>`_ by the Yocto Project.
 
 * Packages `needed <http://www.yoctoproject.org/docs/1.5.1/ref-manual/ref-manual.html#required-packages-for-the-host-development-system>`_
 
 
-How can I save space after a built?
+How can I save space after a build?
 -----------------------------------
 
-* Append ``INHERIT += "rm_work"`` to your ``local.conf`` file. This feature will indicate
-  ``bitbake`` to remove the working folder ``tmp/work`` after (bit)baking so next 
-  time you create an image, it will basically execute all recipes' tasks except the 
+* Add  ``INHERIT += "rm_work"`` to your ``local.conf`` file. This feature will instruct
+  ``bitbake`` to remove the working folder ``tmp/work`` after (bit)baking, so the next
+  time you create an image it will basically execute all recipe tasks except the
   fetching step.
 
-* In case you just need a particular file system's type, append ``IMAGE_FSTYPES = "tar.bz2"``
+* In case you just need a particular file system type, add ``IMAGE_FSTYPES = "tar.bz2"``
   to your ``local.conf``.
 
 Where do I check for known bugs?
-----------------------------------
+--------------------------------
 
-The known bugs are handled using the `Yocto Project Bugzilla <https://bugzilla.yoctoproject.org/buglist.cgi?quicksearch=meta-fsl-arm>`_
+The known bugs are tracked using `Yocto Project Bugzilla <https://bugzilla.yoctoproject.org/buglist.cgi?quicksearch=meta-fsl-arm>`_
 
 
 Are there prebuilt images available?
 ------------------------------------
 
-Kindly provided by `O.S. Systems <http://ci.ossystems.com.br/public/fsl-community-bsp/>`_
+Yes, kindly provided by `O.S. Systems <http://ci.ossystems.com.br/public/fsl-community-bsp/>`_
diff --git a/FAQ/source/index.rst b/FAQ/source/index.rst
index 6152e71..536db6d 100644
--- a/FAQ/source/index.rst
+++ b/FAQ/source/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Freescale Community BSP FAQ's documentation!
+Welcome to Freescale Community's BSP FAQ!
 =======================================================
 
 
-- 
1.7.9.5

More information about the meta-freescale mailing list