[ptxdist] [PATCH 1/2] doc: dev_manual: add explanation of *_SOURCE variable

[ptxdist] [PATCH 1/2] doc: dev_manual: add explanation of *_SOURCE variable

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/dev_manual.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
index cd1d2e9fc098..e83584634c06 100644
--- a/doc/dev_manual.rst
+++ b/doc/dev_manual.rst
@@ -368,6 +368,8 @@ PTXdist specific. What does it mean:
    alternative download locations are known, they can be listed in this
    variable, delimiter character is the space.
 
+-  ``*_SOURCE`` tells PTXdist where to store the downloaded package.
+
 -  ``*_DIR`` points to the directory this package will be build later on
    by PTXdist
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH 2/2] doc: dev_manual: fix typos

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/dev_manual.rst | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
index e83584634c06..d79ebdba780d 100644
--- a/doc/dev_manual.rst
+++ b/doc/dev_manual.rst
@@ -18,7 +18,7 @@ This chapter shows all (or most) of the details of how PTXdist works.
 
 .. _directory_hierarchy:
 
-PTXdist’s directory hierarchy
+PTXdist’s Directory Hierarchy
 -----------------------------
 
 .. note:: Referenced directories are meant relative to the PTXdist main
@@ -127,7 +127,7 @@ next time PTXdist builds the root filesystem it will use the local
 
 .. _adding_new_packages:
 
-Adding new Packages
+Adding New Packages
 -------------------
 
 PTXdist provides a huge amount of applications sufficient for the most
@@ -370,8 +370,8 @@ PTXdist specific. What does it mean:
 
 -  ``*_SOURCE`` tells PTXdist where to store the downloaded package.
 
--  ``*_DIR`` points to the directory this package will be build later on
-   by PTXdist
+-  ``*_DIR`` points to the directory this package will be built later on
+   by PTXdist.
 
 -  ``*_LICENSE`` enables the user to get a list of licenses she/he is
    using in her/his project (licenses of the enabled packages).
@@ -610,7 +610,7 @@ The “header” of this stage defines some information IPKG needs. The
 important part that we must modify is the call to the ``install_copy``
 macro (refer to section :ref:`reference_macros` for more details
 about this kind of macros). This call instructs PTXdist to include the
-given file (with PID, UID and permissions) into the IPKG, which means to
+given file (with UID, GID and permissions) into the IPKG, which means to
 install this file to the target’s root filesystem.
 
 From the previous *install* stage we know this package installs an
@@ -667,7 +667,7 @@ One last task of this port is still open: A reasonable location for
 the new menu entry in PTXdist’s menu hierarchy. PTXdist arranges its
 menus on the meaning of each package. Is it a network related tool? Or
 a scripting language? Or a graphical application?
-Each of these global meanings have their own submenu, where we can add
+Each of these global meanings has its own submenu, where we can add
 our new entry to. We just have to edit the head of our new menu file
 ``./rules/foo.in`` to add it to a specific global menu. If our new
 package is a network related tool, the head of the menu file should
@@ -741,7 +741,7 @@ for example). To make life easier for everybody the license for a package must
 be provided. *SPDX* license identifiers unify the license names and are used
 in PTXdist to identify license types and obligations.
 
-If a package comes with more than one license, alls of their SPDX identifiers
+If a package comes with more than one license, all of their SPDX identifiers
 must be listed and connected with the keyword ``AND``. If your package comes
 with GPL-2.0 and LGPL-2.1 licenses, the definition should look like this:
 
@@ -840,7 +840,7 @@ To do a fast check if this addition was successful, we run:
 
 .. note:: It depends on the currently selected platform and its architecture
  what content this variable will have. The content shown above is an
- example for an target.
+ example for a target.
 
 Or re-build the package with the new settings:
 
@@ -1285,7 +1285,7 @@ Creating a Patch Series for a Package
 To create a patch series for the first time, we can run the following
 steps. We are still using our *foo-1.1.0* example package here:
 
-Using quilt
+Using Quilt
 """""""""""
 
 We create a special directory for the patch series in the local project
@@ -1382,7 +1382,7 @@ that are autogenerated in autotools-based buildsystems.
 Refer to section :ref:`configure_rebuild` on how PTXdist can
 handle this special task.
 
-Adding more Patches to a Package
+Adding More Patches to a Package
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If we want to add more patches to an already patched package, we can use
@@ -1449,7 +1449,7 @@ content can be:
 
 .. _adding_files:
 
-Adding binary only Files
+Adding Binary Only Files
 ------------------------
 
 Sometimes a few binary files have to be added into the root filesystem.
@@ -1460,7 +1460,7 @@ On the other hand, sometimes files should be included that are not
 covered by any open source license and so, should not be shipped in the
 source code format.
 
-Add binary Files File by File
+Add Binary Files File by File
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Doing to on a file by file base can happen by just using the ``install_copy``
@@ -1481,7 +1481,7 @@ file, we need one call to the ``install_copy`` macro per file. This is
 even harder if not only a set of files is to be installed, but a whole
 directory tree with files instead.
 
-Add binary Files via an Archive
+Add Binary Files via an Archive
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If a whole tree of files is to be installed, working with a *tar* based
@@ -1553,10 +1553,10 @@ Enabling this new entry will also run our stages in
 
     $ ptxdist go
 
-Creating new Package Templates
+Creating New Package Templates
 ------------------------------
 
-For larger project it can be convenient to have project specific package
+For larger projects it can be convenient to have project specific package
 templates. This can be achieved by either modifying existing templates or
 by creating completely new templates.
 
@@ -1572,7 +1572,7 @@ only difference is, that it searches in the ``templates/`` subdirectory.
 So a modified ``./rules/templates/template-target-make`` can be used to
 tweak the ``target`` template.
 
-Creating a new Template
+Creating a New Template
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 For a completely new template, some bash scripting is required. All shell
@@ -1590,14 +1590,14 @@ The minimum requirement for a new template is:
     }
     export -f ptxd_template_new_mypkg
     ptxd_template_help_list[${#ptxd_template_help_list[@]}]="mypkg"
-    ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create awsame mypkg package"
+    ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create awesome mypkg package"
 
-PTXdist provides several helper functions to simply the template.
+PTXdist provides several helper functions to simplify the template.
 Using those functions, the package creation process is split into two
 parts:
 
--  query the user for input and export variables
--  Create the new package files from the template source files by
+-  query the user for input and export variables.
+-  create the new package files from the template source files by
    substituting all instances of ``@<variable>@`` with the value of the
    corresponding variable.
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH 2/2] doc: dev_manual: fix typos

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/dev_manual.rst | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
index e83584634c06..d79ebdba780d 100644
--- a/doc/dev_manual.rst
+++ b/doc/dev_manual.rst
@@ -18,7 +18,7 @@ This chapter shows all (or most) of the details of how PTXdist works.
 
 .. _directory_hierarchy:
 
-PTXdist’s directory hierarchy
+PTXdist’s Directory Hierarchy
 -----------------------------
 
 .. note:: Referenced directories are meant relative to the PTXdist main
@@ -127,7 +127,7 @@ next time PTXdist builds the root filesystem it will use the local
 
 .. _adding_new_packages:
 
-Adding new Packages
+Adding New Packages
 -------------------
 
 PTXdist provides a huge amount of applications sufficient for the most
@@ -370,8 +370,8 @@ PTXdist specific. What does it mean:
 
 -  ``*_SOURCE`` tells PTXdist where to store the downloaded package.
 
--  ``*_DIR`` points to the directory this package will be build later on
-   by PTXdist
+-  ``*_DIR`` points to the directory this package will be built later on
+   by PTXdist.
 
 -  ``*_LICENSE`` enables the user to get a list of licenses she/he is
    using in her/his project (licenses of the enabled packages).
@@ -610,7 +610,7 @@ The “header” of this stage defines some information IPKG needs. The
 important part that we must modify is the call to the ``install_copy``
 macro (refer to section :ref:`reference_macros` for more details
 about this kind of macros). This call instructs PTXdist to include the
-given file (with PID, UID and permissions) into the IPKG, which means to
+given file (with UID, GID and permissions) into the IPKG, which means to
 install this file to the target’s root filesystem.
 
 From the previous *install* stage we know this package installs an
@@ -667,7 +667,7 @@ One last task of this port is still open: A reasonable location for
 the new menu entry in PTXdist’s menu hierarchy. PTXdist arranges its
 menus on the meaning of each package. Is it a network related tool? Or
 a scripting language? Or a graphical application?
-Each of these global meanings have their own submenu, where we can add
+Each of these global meanings has its own submenu, where we can add
 our new entry to. We just have to edit the head of our new menu file
 ``./rules/foo.in`` to add it to a specific global menu. If our new
 package is a network related tool, the head of the menu file should
@@ -741,7 +741,7 @@ for example). To make life easier for everybody the license for a package must
 be provided. *SPDX* license identifiers unify the license names and are used
 in PTXdist to identify license types and obligations.
 
-If a package comes with more than one license, alls of their SPDX identifiers
+If a package comes with more than one license, all of their SPDX identifiers
 must be listed and connected with the keyword ``AND``. If your package comes
 with GPL-2.0 and LGPL-2.1 licenses, the definition should look like this:
 
@@ -840,7 +840,7 @@ To do a fast check if this addition was successful, we run:
 
 .. note:: It depends on the currently selected platform and its architecture
  what content this variable will have. The content shown above is an
- example for an target.
+ example for a target.
 
 Or re-build the package with the new settings:
 
@@ -1285,7 +1285,7 @@ Creating a Patch Series for a Package
 To create a patch series for the first time, we can run the following
 steps. We are still using our *foo-1.1.0* example package here:
 
-Using quilt
+Using Quilt
 """""""""""
 
 We create a special directory for the patch series in the local project
@@ -1382,7 +1382,7 @@ that are autogenerated in autotools-based buildsystems.
 Refer to section :ref:`configure_rebuild` on how PTXdist can
 handle this special task.
 
-Adding more Patches to a Package
+Adding More Patches to a Package
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If we want to add more patches to an already patched package, we can use
@@ -1449,7 +1449,7 @@ content can be:
 
 .. _adding_files:
 
-Adding binary only Files
+Adding Binary Only Files
 ------------------------
 
 Sometimes a few binary files have to be added into the root filesystem.
@@ -1460,7 +1460,7 @@ On the other hand, sometimes files should be included that are not
 covered by any open source license and so, should not be shipped in the
 source code format.
 
-Add binary Files File by File
+Add Binary Files File by File
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Doing to on a file by file base can happen by just using the ``install_copy``
@@ -1481,7 +1481,7 @@ file, we need one call to the ``install_copy`` macro per file. This is
 even harder if not only a set of files is to be installed, but a whole
 directory tree with files instead.
 
-Add binary Files via an Archive
+Add Binary Files via an Archive
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If a whole tree of files is to be installed, working with a *tar* based
@@ -1553,10 +1553,10 @@ Enabling this new entry will also run our stages in
 
     $ ptxdist go
 
-Creating new Package Templates
+Creating New Package Templates
 ------------------------------
 
-For larger project it can be convenient to have project specific package
+For larger projects it can be convenient to have project specific package
 templates. This can be achieved by either modifying existing templates or
 by creating completely new templates.
 
@@ -1572,7 +1572,7 @@ only difference is, that it searches in the ``templates/`` subdirectory.
 So a modified ``./rules/templates/template-target-make`` can be used to
 tweak the ``target`` template.
 
-Creating a new Template
+Creating a New Template
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 For a completely new template, some bash scripting is required. All shell
@@ -1590,14 +1590,14 @@ The minimum requirement for a new template is:
     }
     export -f ptxd_template_new_mypkg
     ptxd_template_help_list[${#ptxd_template_help_list[@]}]="mypkg"
-    ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create awsame mypkg package"
+    ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create awesome mypkg package"
 
-PTXdist provides several helper functions to simply the template.
+PTXdist provides several helper functions to simplify the template.
 Using those functions, the package creation process is split into two
 parts:
 
--  query the user for input and export variables
--  Create the new package files from the template source files by
+-  query the user for input and export variables.
+-  create the new package files from the template source files by
    substituting all instances of ``@<variable>@`` with the value of the
    corresponding variable.
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de