From 1f65ee76fc69009ebfbc8b53536574dde0511860 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Bar=C4=87?= Date: Mon, 28 Sep 2020 14:16:25 +0200 Subject: [PATCH 1/3] contributing: add development workflow notes --- CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++- README.md | 10 ------ 2 files changed, 83 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a72e209..a679ac7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,4 +73,86 @@ and you have fixed an error, the commit or merge request should look like this: `mail-client/freelook-bin: fix QA - EROOT missing slash` -**This system also applies on your metadata.xml and Manifest.** \ No newline at end of file +**This system also applies on your metadata.xml and Manifest.** + +## Development workflow + +### Add the overlay to the system +Edit /etc/portage/repos.conf/src_prepare-overlay.conf (as root) +```toml +[src_prepare-overlay] +auto-sync = yes +location = /var/db/repos/src_prepare-overlay +sync-git-clone-extra-opts = --depth=999999999 --no-shallow-submodules --no-single-branch --verbose +sync-git-pull-extra-opts = --depth=999999999 --verbose +sync-type = git +sync-uri = git@gitlab.com:src_prepare/src_prepare-overlay.git +sync-user = :portage +``` +If you dont have write access to the cloned branch yet use "sync-uri = https://gitlab.com/src_prepare/src_prepare-overlay.git" instead. + +### Sync the overlay +As root +```bash +emaint sync -r src_prepare-overlay +``` + +### Add new package + +#### Basics +As user +```bash +cd /var/db/repos/src_prepare-overlay +mkdir -p category/package-name +cd category/package-name +touch metadata.xml +touch package-name-package-version.ebuild +``` +Now edit the ebuild and metadata files accordingly. +[https://devmanual.gentoo.org/](For ebuild developemnt details look here) + +#### Tests +If a package's upstream has tests don't forget to enable them. +If they fail describe why in the comments inside the ebuild +(but please make the descriptions reasonably short). + +##### Package testing +Make sure you have FEATURES="test" enabled in the make.conf +```bash +echo 'FEATURES="${FEATURES} test"' >> make.conf +``` +And then, as root +```bash +echo "categroy/package-name test" >> /etc/portage/package.use/development-tests +``` + +##### Ebuild testing +repoman (app-portage/repoman) and pkgcheck (dev-util/pkgcheck) +will give you a report of what should be fixed. +```bash +repoman -Idx full +pkgcheck scan +``` + +#### Metadata +metadata.xml should contain at least these lines: +```xml + + + + + organization-or-user/package + + +``` +Adjust the "type" and "organization-or-user/package" accordingly. + +#### Installation +If the (system wide) repository is set up correctly you should be able to just emerge the package you added right away +```bash +emegre --ask --verbose --jobs=1 --quiet-build=n categroy/package-name +``` + +#### Git +Follow the rules described in "Submitting Merge Requests" section. +GPG signing is not required but encouraged. Gentoo Wiki provides a great example [https://wiki.gentoo.org/wiki/Project:Infrastructure/Generating_GLEP_63_based_OpenPGP_keys](how to create a strong key). diff --git a/README.md b/README.md index 426e9a2..1ae3cf6 100644 --- a/README.md +++ b/README.md @@ -88,13 +88,3 @@ See [examples/package.accept_keywords/src_prepare-overlay](https://gitlab.com/sr ## Contributing We appreciate and encourage for contribution. If you want a specific package or want to create a package for us to maintain, see [CONTRIBUTING.md](/CONTRIBUTING.md). - - -## Quick maintainer guide - -### Testing ebuilds - -``` sh -repoman manifest -ebuild FILE clean merge -``` From bb979fe5ef3551997e86eb1a91e0222852c78a6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Bar=C4=87?= Date: Mon, 28 Sep 2020 14:23:31 +0200 Subject: [PATCH 2/3] contributing: fix spelling and links --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a679ac7..62f710a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -109,7 +109,7 @@ touch metadata.xml touch package-name-package-version.ebuild ``` Now edit the ebuild and metadata files accordingly. -[https://devmanual.gentoo.org/](For ebuild developemnt details look here) +[For ebuild developemnt details look here](https://devmanual.gentoo.org/) #### Tests If a package's upstream has tests don't forget to enable them. @@ -123,7 +123,7 @@ echo 'FEATURES="${FEATURES} test"' >> make.conf ``` And then, as root ```bash -echo "categroy/package-name test" >> /etc/portage/package.use/development-tests +echo "category/package-name test" >> /etc/portage/package.use/development-tests ``` ##### Ebuild testing @@ -150,9 +150,9 @@ Adjust the "type" and "organization-or-user/package" accordingly. #### Installation If the (system wide) repository is set up correctly you should be able to just emerge the package you added right away ```bash -emegre --ask --verbose --jobs=1 --quiet-build=n categroy/package-name +emegre --ask --verbose --jobs=1 --quiet-build=n category/package-name ``` #### Git -Follow the rules described in "Submitting Merge Requests" section. -GPG signing is not required but encouraged. Gentoo Wiki provides a great example [https://wiki.gentoo.org/wiki/Project:Infrastructure/Generating_GLEP_63_based_OpenPGP_keys](how to create a strong key). +Follow the rules described in ["Submitting Merge Requests"](#submitting-merge-requests-1) section. +GPG signing is not required but encouraged. Gentoo Wiki provides a great example [how to create a strong key](https://wiki.gentoo.org/wiki/Project:Infrastructure/Generating_GLEP_63_based_OpenPGP_keys). From f5a94c20acd5e11f05fba04ffba0946953e6b98d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Bar=C4=87?= Date: Mon, 28 Sep 2020 15:58:28 +0200 Subject: [PATCH 3/3] eclass/mozconfig-v6.56: remove deprecated ffmpeg virtual --- eclass/mozconfig-v6.56.eclass | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/eclass/mozconfig-v6.56.eclass b/eclass/mozconfig-v6.56.eclass index 6234be3..be0d2bb 100644 --- a/eclass/mozconfig-v6.56.eclass +++ b/eclass/mozconfig-v6.56.eclass @@ -112,7 +112,7 @@ RDEPEND=" dev-libs/expat dev-libs/libffi media-libs/fontconfig - virtual/ffmpeg + media-video/ffmpeg virtual/freedesktop-icon-theme x11-libs/gdk-pixbuf x11-libs/libX11 @@ -140,7 +140,6 @@ RDEPEND=" startup-notification? ( >=x11-libs/startup-notification-0.8 ) - system-icu? ( >=dev-libs/icu-59.1:= )