| OLD | NEW |
| 1 naclports - Ports of open source software to Native Client | 1 naclports - Ports of open source software to Native Client |
| 2 ========================================================== | 2 ========================================================== |
| 3 | 3 |
| 4 naclports is collection of open source libraries and applications that have | 4 naclports is collection of open source libraries and applications that have |
| 5 been ported to Native Client, along with set to tools for building and | 5 been ported to Native Client, along with set to tools for building and |
| 6 maintaining them. | 6 maintaining them. |
| 7 | 7 |
| 8 Packages can be built from source or prebuilt binaries packages can be | 8 Packages can be built from source or prebuilt binaries packages can be |
| 9 downloaded from the continuous build system. | 9 downloaded from the continuous build system. |
| 10 | 10 |
| (...skipping 202 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 213 run ``shellcheck`` to catch common errors. The recommended command line | 213 run ``shellcheck`` to catch common errors. The recommended command line |
| 214 for this is:: | 214 for this is:: |
| 215 | 215 |
| 216 shellcheck -e SC2044,SC2129,SC2046,SC2035,SC2034,SC2086,SC2148 \ | 216 shellcheck -e SC2044,SC2129,SC2046,SC2035,SC2034,SC2086,SC2148 \ |
| 217 `git ls-files "*.sh"` | 217 `git ls-files "*.sh"` |
| 218 | 218 |
| 219 Modifying package sources / Working with patches | 219 Modifying package sources / Working with patches |
| 220 ------------------------------------------------ | 220 ------------------------------------------------ |
| 221 | 221 |
| 222 When a package is first built, its source is downloaded and extracted to | 222 When a package is first built, its source is downloaded and extracted to |
| 223 ``out/build/<PKG_NAME>``. A new git repository is then created in this | 223 ``out/build/<pkg_name>``. A new git repository is then created in this |
| 224 folder with the original archive contents on a branch called ``upstream``. The | 224 folder with the original archive contents on a branch called ``upstream``. The |
| 225 optional ``nacl.patch`` file is then applied on the ``master`` branch. This | 225 optional ``nacl.patch`` file is then applied on the ``master`` branch. This |
| 226 means that at any given time you can see the changes from upstream using ``git | 226 means that at any given time you can see the changes from upstream using ``git |
| 227 diff upstream``. | 227 diff upstream``. |
| 228 | 228 |
| 229 To make changes to a package's patch file the recommended workflow is: | 229 To make changes to a package's patch file the recommended workflow is: |
| 230 | 230 |
| 231 1. Directly modify the sources in ``out/build/PKG_NAME``. | 231 1. Directly modify the sources in ``out/build/<pkg_name>``. |
| 232 2. Build the package and verify the changes. | 232 2. Build the package and verify the changes. |
| 233 3. Use ``git diff upstream.. > ../path/to/nacl.patch`` to regenerate | 233 3. Use ``naclpors updatepatch <pkg_name>`` to (re)generate the patch file. |
| 234 the patch file. | |
| 235 | 234 |
| 236 Whenever the upstream archive or patch file changes and you try to build the | 235 Whenever the upstream archive or patch file changes and you try to build the |
| 237 package you will be prompted to remove the existing repository and start a new | 236 package you will be prompted to remove the existing repository and start a new |
| 238 one. This is to avoid deleting a repository that might have unsaved changed. | 237 one. This is to avoid deleting a repository that might contain unsaved changed. |
| 239 | 238 |
| 240 Happy porting! | 239 Happy porting! |
| OLD | NEW |