Difference between revisions of "Development Guide"

Revision as of 01:47, February 20, 2019

To get started with Funtoo development, it's strongly recommended that you first watch the following video, which will introduce you to code.funtoo.org and explain how to use it to fork a repository and create a pull request. Forking a repository and creating a pull request is the best way to start doing Funtoo development:

To learn more about ebuilds and how to write them, the following pages are available:

Ebuild Writing

Portage Variables -- learn about all those variables inside an ebuild, and in make.conf.
Ebuild Functions -- src_unpack, src_compile -- these are ebuild functions. There are others. See all of them and learn how they work.

For a more comprehensive reference of all the details of ebuild development, please see the Gentoo Development Manual.

Advanced Topics

If you are maintaining several ebuilds for Funtoo, you may find it more convenient to maintain your own overlay and have us pull new versions of ebuilds from you, rather than having to create a pull request. For information on how to do this, see Local_Overlay.

Even more advanced users may want to use our own tree update scripts to generate their own customized meta-repo and kits. For information on how to do this, see Local Development Setup. This document also covers the functionality of our tree update scripts in detail, and will give you some insight into how to work with the kit-fixups repository effectively.

Pages that need updating

Forking An Ebuild -- explains how to take an ebuild from Gentoo and fork it, so you can make local changes.
Portage (Funtoo) -- learn about Funtoo changes to Portage (needs updating).
Portage Dynamic Slot - dynamic SLOT functionality now in Portage.

Metro

Metro Quick Start Tutorial -- learn how to use Metro, our automated build tool.
Metro - a full index of Metro-related documentation.

@@ Line 1: / Line 1: @@
-This page is intended to be a developer guide for Funtoo Linux.
+To get started with Funtoo development, it's strongly recommended that you first watch the following video, which will introduce you to code.funtoo.org and explain how to use it to fork a repository and create a pull request. Forking a repository and creating a pull request is the best way to start doing Funtoo development:
-{{Note|Please see [[Local Development Setup]] for a definitive guide on kit internals and how to set up a local Funtoo Linux development environment.}}
+{{#evt:service=youtube|id=https://youtu.be/V6PfB64oMWo|dimensions=480|alignment=center|autoresize=true}}
-== Reference ==
+To learn more about ebuilds and how to write them, the following pages are available:
-=== Learn About Ebuilds ===
+=== Ebuild Writing ===
-* [[Local_Overlay]] -- take the crash course of setting up a local overlay, revision bumping a package, testing, and syncing to github.
-* [[Git_local_overlay]] -- drobbins' local overlay guide, less of a crash course, better permissions, and better suited for large overlays.
-* [[Forking An Ebuild]] -- explains how to take an ebuild from Gentoo and fork it, so you can make local changes.
+* [[Portage Variables]] -- learn about all those variables inside an ebuild, and in <tt>make.conf</tt>.
+* [[Ebuild Functions]] -- <tt>src_unpack</tt>, <tt>src_compile</tt> -- these are ebuild functions. There are others. See all of them and learn how they work.
+For a more comprehensive reference of all the details of ebuild development, please see the [https://devmanual.gentoo.org/ Gentoo Development Manual.]
+=== Advanced Topics ===
-=== Funtoo Internals ===
+If you are maintaining several ebuilds for Funtoo, you may find it more convenient to maintain your own ''overlay'' and have us pull new versions of ebuilds from you, rather than having to create a pull request. For information on how to do this, see [[Local_Overlay]].
-* [[Portage Variables]] -- learn about all those variables inside an ebuild, and in <tt>make.conf</tt>.
+Even more advanced users may want to use our own tree update scripts to generate their own customized meta-repo and kits. For information on how to do this, see [[Local Development Setup]]. This document also covers the functionality of our tree update scripts in detail, and will give you some insight into how to work with the {{c|kit-fixups}} repository effectively.
-* [[Ebuild Functions]] -- <tt>src_unpack</tt>, <tt>src_compile</tt> -- these are ebuild functions. There are others. See all of them and learn how they work.
-=== Portage ===
+== Pages that need updating ==
+* [[Forking An Ebuild]] -- explains how to take an ebuild from Gentoo and fork it, so you can make local changes.
 * [[Portage (Funtoo)]] -- learn about Funtoo changes to Portage (needs updating).
 * [[Portage Dynamic Slot]] - dynamic SLOT functionality now in Portage.
@@ Line 26: / Line 28: @@
 * [[Metro Quick Start Tutorial]] -- learn how to use Metro, our automated build tool.
 * [[Metro]] - a full index of Metro-related documentation.
-=== Working With Git ===
-Also check out:
-* [[Git Merging Guide]]
-Learning how to help squash out bugs can be a difficult thing to do, especially since sometimes JIRA looks a little overwhelming and confusing. A thank you to Daniel for making some videos (see below) on explaining this better, but there were a couple things left out. So I will take you through that. (With picture reference).
-The first thing you're going to want to do is make an account, which is simple as clicking on the 'Log in' button on the top right, then clicking 'Sign up'.
-[[File:Signupjira.png|720px|center]]
-After you've made your account, the best way to watch bugs is to click on the 'Agile' drop-down menu, and choose 'Classic'.
-[[File:Agileclassic.png|720px|center]]
-Now, we're going to want to change a couple things even with this. By default, the 'Classic' mode takes you to 'Classic Planning Board', you want to change this to 'Classic Task Board'. This makes things much easier to read.
-I also recommend going to the '''Views''' eyeball icon to the right and selecting the '''List''' issue view, and the '''Compact (Kanban)''' task board mode. This will give you a top-level overview of all our bugs and their statuses, and JIRA will remember your view preferences the next time you log in.
-[[File:Classicview.png|720px|center]]
-After that, we're almost ready to rock and roll. We need to also make sure that you're not set to any version or we'll only see a few bugs. So in case it says '1.1' or '1.0' change it to 'Unscheduled'.
-[[File:Jiraversion.png|720px|center]]
-And after all that, you can view and look at bugs that are in queue, To-do, or testing, which Daniel's videos are very great at explaining. Thanks for helping Funtoo Linux better and better.
-<center>
-{{#ev:youtube|https://youtu.be/JCg5DWjy6Ro|autoresize}}
-{{#ev:youtube|https://youtu.be/tuFE9ZgVOpY|autoresize}}
 [[Category:Development]]
+[[Category:Official Documentation]]