riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pkg: update patch documentation

Browse Source
This commit is contained in:
Koen Zandberg 2018-09-19 20:08:06 +02:00
parent b518f3c73e
commit 78bc777cad
No known key found for this signature in database
GPG Key ID: 0895A893E6D2985B
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/doc.txt
View File

@ -21,15 +21,16 @@
* This module provides porting information for libraries and applications to use * This module provides porting information for libraries and applications to use
* with RIOT (to build an external module). If you'd like to add a package to RIOT * with RIOT (to build an external module). If you'd like to add a package to RIOT
* you need to add a directory with the name of your package to this directory. * you need to add a directory with the name of your package to this directory.
* This directory should contain at least two files: * This directory should contain at least one file:
* *
* * **Zero or more patch files**: Your patches of the upstream application of
* the package to make it build with RIOT.
* * **Makefile**: A Makefile describing how to get the upstream application, * * **Makefile**: A Makefile describing how to get the upstream application,
* apply the patch and how to build the package as a RIOT module. * apply the patch and how to build the package as a RIOT module.
* A rough template for several methods of acquiring a package is provided in * A rough template for several methods of acquiring a package is provided in
* `pkg/Makefile.git`, `pkg/Makefile.http`, and `pkg/Makefile.svn` * `pkg/Makefile.git`, `pkg/Makefile.http`, and `pkg/Makefile.svn`
* *
* Patch files can be included in a `patches` directory in the package dir.
* These are applied to the upstream package to make it build with RIOT.
*
* Creating a patch with git * Creating a patch with git
* ------------------------- * -------------------------
* Assuming your upstream library resides in a git repository, you can create the * Assuming your upstream library resides in a git repository, you can create the
@ -39,6 +40,6 @@
* * conduct necessary changes (e.g. edit, add, or remove some files) * * conduct necessary changes (e.g. edit, add, or remove some files)
* * commit your changes using `git commit` * * commit your changes using `git commit`
* * create the patch files using `git format-patch -n riot-port` * * create the patch files using `git format-patch -n riot-port`
* * move the resulting patch files to the corresponding subfolder of pkg * * move the resulting patch files to the patches directory of your package.
* @} * @}
*/ */