tazpkg diff README.devel @ rev 971

modules/get: fix plain mode and cookmode again
author Aleksej Bobylev <al.bobylev@gmail.com>
date Mon Nov 26 20:27:56 2018 +0200 (2018-11-26)
parents bbc6b0a453a7
children
line diff
     1.1 --- a/README.devel	Sat Dec 19 15:39:06 2015 +0200
     1.2 +++ b/README.devel	Mon Nov 26 20:27:56 2018 +0200
     1.3 @@ -21,7 +21,7 @@
     1.4  TazPkg modules
     1.5  --------------
     1.6  
     1.7 -About 4,000 lines of code is too big to effectively maintain it in single file.
     1.8 +About 4,000 lines of code is too big to effectively maintain in a single file.
     1.9  
    1.10  Linux way [https://en.wikibooks.org/wiki/Linux_Guide/How_Linux_Works]:
    1.11  > The Linux Way can be summarized as:
    1.12 @@ -32,15 +32,15 @@
    1.13  >   * There is no "one true way" to do anything.
    1.14  >   * Prefer commandline tools over graphical tools.
    1.15  
    1.16 -It decided to split single tazpkg code into few independent modules.
    1.17 +It is decided to split single tazpkg code into a few independent modules.
    1.18  
    1.19 -Goals: not to scroll thousand of lines to move forth and back to the internal
    1.20 +Goals: not to scroll thousands of lines to move back and forth to the internal
    1.21  tazpkg functions and to the main tazpkg code; knowledge that single code
    1.22 -changing in the one place will not have side effect in the other place; reduce
    1.23 +changing in the one place will not have side effects in the other place; reduce
    1.24  the barrier to entry for new developers.
    1.25  
    1.26  
    1.27 -Place best fit tazpkg modules is /usr/libexec directory.
    1.28 +Best place to fit tazpkg modules is /usr/libexec directory.
    1.29  http://www.linuxbase.org/betaspecs/fhs/fhs/ch04s07.html
    1.30  
    1.31  > /usr/libexec includes internal binaries that are not intended to be executed
    1.32 @@ -51,7 +51,7 @@
    1.33  > store internal binaries, though they may use /usr/lib for the other purposes
    1.34  > documented here.
    1.35  
    1.36 -So, directory for tazpkg modules is /usr/libexec/tazpkg/.
    1.37 +So, the directory for tazpkg modules is /usr/libexec/tazpkg/.
    1.38  It is out of the PATH, so modules will not interfere with original Linux
    1.39  commands and will not autocomplete in the terminal. Nothing changed with the
    1.40  user experience: it is still single tazpkg.
    1.41 @@ -78,15 +78,15 @@
    1.42  Code commenting
    1.43  ---------------
    1.44  
    1.45 -Developer comments are very important to understand how program works.
    1.46 -But that comments are useless to the end user and they just increase the size
    1.47 +Developer comments are very important to understand how the program works.
    1.48 +But these comments are useless to the end user and they just increase the size
    1.49  of the scripts without making any changes to the script business logic. It also
    1.50 -increase the size of the scripts that includes shared "libs" such as libtaz.sh.
    1.51 +increases the size of the scripts that includes shared "libs" such as libtaz.sh.
    1.52  
    1.53 -We can strip all the comments from installed scripts, leaving that comments
    1.54 +We can strip all the comments from installed scripts, leaving those comments
    1.55  for developers in the SliTaz Hg repositories.
    1.56  
    1.57 -We need only to leave "#!/bin/sh" line and one-two lines of comments described
    1.58 +We need only to leave "#!/bin/sh" line and one or two lines of comments describing
    1.59  what it is and where you can find the original scripts if you want to develop
    1.60  them.
    1.61  
    1.62 @@ -96,13 +96,13 @@
    1.63  
    1.64  Tests are the important part of the development process. TazPkg development is
    1.65  not easy. We have no automated tests at the moment. Only we can do manual tests,
    1.66 -but we even have no check-list.
    1.67 +but even we have no check-list.
    1.68  
    1.69  To test tazpkg effectively we need two sorts of the tests. One set of the tests
    1.70  we can reproduce in the local file system (inside special prepared chroot
    1.71 -environment). For other tests we need special test-server that provide special
    1.72 -test cases (emulate package database changes), also provide both main and few
    1.73 -undigest repositories. We can set up special scripts and test repository on the
    1.74 +environment). For other tests we need a special test-server that provides special
    1.75 ++test cases (emulate package database changes), this also provides both main and few
    1.76 ++undigest repositories. We can set up special scripts and test repositories on the
    1.77  existing server (cook.slitaz.org).
    1.78  
    1.79  
    1.80 @@ -119,7 +119,7 @@
    1.81      PRE=$(echo "$HLP" | sed ...
    1.82  
    1.83  Here $HLP is a part of the HTML page that we are going to show. Next the chain
    1.84 -of sed commands are transformed this HTML source in the next way.
    1.85 +of sed commands are transformed in this HTML source in the next way.
    1.86  
    1.87    * `/^$/d;` remove blank lines;
    1.88    * `/<pre>/,/<\/pre\>/{s|.*|  &|; s| |·|g};` prepend lines within <pre>*</pre>