diff options
Diffstat (limited to 'docs/markdown/Adding-new-projects-to-wrapdb.md')
| -rw-r--r-- | docs/markdown/Adding-new-projects-to-wrapdb.md | 39 |
1 files changed, 32 insertions, 7 deletions
diff --git a/docs/markdown/Adding-new-projects-to-wrapdb.md b/docs/markdown/Adding-new-projects-to-wrapdb.md index e14e0ac..4420de5 100644 --- a/docs/markdown/Adding-new-projects-to-wrapdb.md +++ b/docs/markdown/Adding-new-projects-to-wrapdb.md @@ -1,18 +1,35 @@ # Adding new projects to wrap -**If you don't have permissions to do something on this page, please open issue against https://github.com/mesonbuild/wrapweb/issues to let us know that you want to start new project.** +**If you don't have permissions to do something on this page, please + open issue against https://github.com/mesonbuild/wrapweb/issues to + let us know that you want to start new project.** ## Overview -The wrap provider service is a simple web service that makes it easy to download build definitions for projects. It works in much the same way as Debian: we take the unaltered upstream source package and add a new build system to it as a patch. These build systems are stored as Git repositories on GitHub. They only contain build definition files. You may also think of them as an overlay to upstream source. +The wrap provider service is a simple web service that makes it easy +to download build definitions for projects. It works in much the same +way as Debian: we take the unaltered upstream source package and add a +new build system to it as a patch. These build systems are stored as +Git repositories on GitHub. They only contain build definition +files. You may also think of them as an overlay to upstream source. ## Creator script -The WrapDB repository has a [helper script](https://github.com/mesonbuild/wrapweb/blob/master/tools/repoinit.py) to generate new repositories. The documentation below roughly explains what it does using plain shell commands. +The WrapDB repository has a [helper +script](https://github.com/mesonbuild/wrapweb/blob/master/tools/repoinit.py) +to generate new repositories. The documentation below roughly explains +what it does using plain shell commands. ## Choosing the repository name -Wrapped subprojects are used much like external dependencies. Thus they should have the same name as the upstream projects. If the project provides a pkg-config file, then the repository name should be the same as the pkg-config name. Usually this is the name of the project, such as `libpng`. Sometimes it is slightly different, however. As an example the libogg project's chosen pkg-config name is `ogg` instead of `libogg`, which is the reason why the repository is named plain `ogg`. +Wrapped subprojects are used much like external dependencies. Thus +they should have the same name as the upstream projects. If the +project provides a pkg-config file, then the repository name should be +the same as the pkg-config name. Usually this is the name of the +project, such as `libpng`. Sometimes it is slightly different, +however. As an example the libogg project's chosen pkg-config name is +`ogg` instead of `libogg`, which is the reason why the repository is +named plain `ogg`. ## Adding new project to the Wrap provider service @@ -61,13 +78,21 @@ First you need to fork the repository to your own page. Then you can create the git commit -a -m 'Created wrap files for libfoo-1.0.0.' git push origin 1.0.0 -Now you can file a merge request. Remember to file it against branch 1.0.0 rather than master. GitHub should do this automatically. +Now you can file a merge request. Remember to file it against branch +1.0.0 rather than master. GitHub should do this automatically. ## Changes to original source -The point of a wrap is to provide the upstream project with as few changes as possible. Most projects should not contain anything more than a few Meson definition files. Sometimes it may be necessary to add a template header file or something similar. These should be held at a minimum. +The point of a wrap is to provide the upstream project with as few +changes as possible. Most projects should not contain anything more +than a few Meson definition files. Sometimes it may be necessary to +add a template header file or something similar. These should be held +at a minimum. -It should especially be noted that there must **not** be any patches to functionality. All such changes must be submitted to upstream. You may also host your own Git repo with the changes if you wish. The Wrap system has native support for Git subprojects. +It should especially be noted that there must **not** be any patches +to functionality. All such changes must be submitted to upstream. You +may also host your own Git repo with the changes if you wish. The Wrap +system has native support for Git subprojects. ## Reviewing wraps |