Category: dev Name: dev/moult Description: Developer overlay Owner: Dion Moult (moult) Committers: moult
Your dev overlay "moult" is almost ready. Please read (all of) this guide to get it to work. If you have any question we'll be here to help. In this Guide ============= - Your overlay versus betagarden - The Initial Push - After That - Online Browsing - Getting into Layman - Keeping your overlay healthy Your overlay versus betagarden ============================== First: what is betagarden? betagarden is a special overlay that - any Gentoo developer is welcome to contribute to (you have write permissions to betagarden already) - is dedicated to ebuilds not important or good enough (i.e. of beta quality) for the main tree. Normally, a package appears in either betagarden or the main tree, but not both. Some of the ebuilds you would normally put into your developer overlay fit betagarden better. The rule of thumb is: If an ebuild (or the related upstream software) is known to be broken or quite experimental: put it in your developer overlay. All else: put it in betagarden. Thanks! Benefits include: - Other Gentoo developers can fix and bump your ebuilds for you - People do not need to keep another overlay around for just a single package they care about. That may reduce reluctance to use your ebuilds with some people. The Initial Push ================ First, before anybody can clone from your overlay an initial push is needed. 0) If you start with an empty repository be sure to setup your identity: # git init # git config user.name 'first last' # git config user.email foo@example.org [..] 1) Once you have ebuilds in there please set profiles/repo_name to 'moult' in order to make it a valid overlay. # mkdir profiles # echo "moult" > profiles/repo_name # git add profiles/repo_name # git commit 2) Now you are ready to push. Proposed way of doing is this: # git remote add overlays-gentoo-org \ git+ssh://git@git.overlays.gentoo.org/dev/moult.git # git push overlays-gentoo-org master After That ========== Online Browsing --------------- After the inital push you can browse your overlay online at: http://git.overlays.gentoo.org/gitweb/?p=dev/moult.git;a=summary Getting into Layman ------------------- We have scripts to get hosted overlay into Layman easily: no need to write XML on your end. Just let us know that you did complete the procedure from "The Initial Push" to get added. Once it's in the Layman registry its content will be indexed at http://gpo.zugaina.org/ and two dedicated views of your overlay will appear at http://gentoo-overlays.zugaina.org/moult/ and http://gpo.zugaina.org/Overlays/moult/, too. Keeping your overlay healthy ---------------------------- A few rules of thumb help to keep your overlay most useful to you and others: - If you package newer versions of software that is packaged in Gentoo already, try to get the version in Gentoo updated, too. (If there is no bump request on https://bugs.gentoo.org/ please file one and share patches you may have produced.) - If you apply custom patches make sure that you never use the very same revision that is used in Gentoo, e.g. if you use the ebuild of app-arch/bzip2-1.0.6-r3 do not call it app-arch/bzip2-1.0.6-r3 in your overlay to avoid confusion. A tool called "overlint" can support you with that process: # sudo emerge -av app-portage/overlint For a quick introduction to overlint see http://blog.hartwork.org/?p=1667 . Sebastian Pipping for the Gentoo Overlays Team
Added to layman, too. Closing. Have fun!
