Differences between revisions 4 and 12 (spanning 8 versions)
Revision 4 as of 2021-05-28 02:46:47
Size: 5628
Editor: PaulWise
Comment: more arch family
Revision 12 as of 2021-06-04 04:23:06
Size: 7713
Editor: GuillemJover
Comment: Make the procedure non-Linux exclusive, and move the kernel as the first toolchain project, reorder items to make toolchain upstreaming the first step
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
Assemble a team of people working on the port and find a financial sponsor to support the team's work. <<TableOfContents>>
Line 9: Line 9:
Identify related ports and ISAs, decide that the port is worth creating and detail the reasons why. = Preparation =
Line 11: Line 11:
Decide on the GNU triplet, [[Multiarch/Tuples|Debian multiarch tuple]], Debian architecture name, the name that end-users will use for the architecture and other [[ArchitectureSpecificsMemo|details]] of the architecture and ABI.   * Assemble a team of people working on the port and find a financial sponsor to support the team's work.
Line 13: Line 13:
Prepare patches supporting the port for [[HelmutGrohne/rebootstrap|rebootstrap]], [[https://savannah.gnu.org/projects/config|GNU config]], dpkg, binutils, gcc, gdb, qemu, glibc, linux projects.   * Register accounts for each team member on the bug trackers and subscribe to the mailing lists for the upstream kernel (such as [[https://www.kernel.org/|Linux]]), [[https://savannah.gnu.org/projects/config|GNU config]], [[https://www.gnu.org/software/binutils/|binutils]], [[https://gcc.gnu.org/|gcc]], [[https://www.gnu.org/software/gdb/|gdb]], [[https://www.qemu.org/|qemu]], [[https://sourceware.org/glibc/|glibc]] projects.
Line 15: Line 15:
Use your modified rebootstrap, the patches and manual [[DebianBootstrap|bootstrapping]] to build all of build-essential. = Upstreaming =
Line 17: Line 17:
Keep working on the bootstrap process until all of build-essential is installable with debootstrap.   * Decide on the [[ArchitectureSpecificsMemo|architecture ABI details]] and the GNU triplet. A different GNU triplet is required for each ABI, which includes bitness, endianness, soft/hard-float, calling convention, or whether object files can be inter-linked.
Line 19: Line 19:
Continue building as many packages as you can using the new build-essential packages.   * Prepare kernel and toolchain patches supporting the port and get the necessary changes included upstream for the kernel (such as [[https://kernelnewbies.org/|Linux]]), [[https://savannah.gnu.org/projects/config|GNU config]] ([[https://git.savannah.gnu.org/cgit/config.git/tree/config.guess|instructions]]), [[https://www.gnu.org/software/binutils/|binutils]], gcc ([[https://gcc.gnu.org/contribute.html|instructions]]), gdb ([[https://www.gnu.org/software/gdb/contribute/|instructions]]), qemu ([[https://www.qemu.org/contribute/|instructions]]), glibc ([[https://sourceware.org/glibc/wiki/Contribution%20checklist|instructions]]) projects.
Line 21: Line 21:
Finalise the architecture details, especially including the ABI and CPU baseline requirements. = Downstreaming =
Line 23: Line 23:
Get the necessary changes included into the upstream GNU config ([[https://git.savannah.gnu.org/cgit/config.git/tree/config.guess|instructions]]), binutils, gcc ([[https://gcc.gnu.org/contribute.html|instructions]], gdb ([[https://www.gnu.org/software/gdb/contribute/|instructions]]), qemu ([[https://www.qemu.org/contribute/|instructions]]), glibc ([[https://sourceware.org/glibc/wiki/Contribution%20checklist|instructions]]), linux ([[https://kernelnewbies.org/|info]]) projects and any other upstream projects that you have modified.   * Identify related ports and ISAs, decide that the port is worth creating and detail the reasons why.
Line 25: Line 25:
Get any necessary changes included into dpkg ([[Teams/Dpkg/FAQ#new-arch|instructions]]), rebootstrap and other Debian packages involved in the bootstrap process.   * Register accounts for each team member on the [[DebianWiki|Debian wiki]] ([[DebianWiki/EditorQuickStart#Account|registration]]) and [[Salsa]] ([[https://salsa.debian.org/users/sign_up|register]]).
Line 27: Line 27:
[[Ports|Register the port]] on the Debian wiki, replace "example" throughout the page with the chosen architecture details and fill out as many details as you have.   * [[https://www.oftc.net/Services/#register-your-account|Register]] and [[https://services.oftc.net/|verify]] accounts for each team member on the [[https://www.oftc.net/|OFTC]] IRC chat network and join the #debian-bootstrap, #debian-ports and other Debian [[IRC]] channels.
Line 29: Line 29:
Summarise the details of the architecture and ABI on the [[ArchitectureSpecificsMemo#Summary|arch summary wiki page]].   * Discuss the port with the community. Please send an email to the DebianList:FIXME mailing list. If the port is related to some other architectures, ensure you CC the mailing list for the architecture family. Also join the #debian-bootstrap and #debian-ports [[IRC]] channels.
Line 31: Line 31:
Setup communication channels for the architecture. Use the architecture family as the name of any communication channels you create, just in case additional related architectures are created later. A [[https://www.debian.org/MailingLists/HOWTO_start_list|mailing list]] and [[IRC#How_to_create_a_new_.23debian-.2A_channel|IRC channel]] are recommended.   * Finalise the architecture details, especially including the ABI and CPU baseline requirements.
Line 33: Line 33:
Add your architecture to the [[Teams/Debbugs/ArchitectureTags|bugs arch usertags page]].   * Get any necessary changes included into dpkg ([[Teams/Dpkg/FAQ#new-arch|instructions]]), to get the new Debian architecture name supported (which is the name that end-users will use for the architecture), this requires having the
 [[ArchitectureSpecificsMemo|architecture ABI details]] clear, the [[Multiarch/Tuples|Debian multiarch tuple]] is derived from the Debian architecture tuple.
Line 35: Line 36:
[[https://www.ports.debian.org/contacts|Get]] the port included amongst the unofficial ports. = Bootstrap =
Line 37: Line 38:
[[https://www.debian.org/devel/buildd/|Setup unofficial buildd servers]] for the port, either in qemu or hardware.   * Prepare patches supporting the port in [[HelmutGrohne/rebootstrap|rebootstrap]] and other Debian-specific packages.
Line 39: Line 40:
Include the port on the [[https://www.debian.org/ports/|ports list on the Debian website]] and add the end-user name for the port to the [[https://salsa.debian.org/webmaster-team/webwml/-/blob/master/english/releases/arches.data|website arches data]]. If you create a page on the website, create one named after the architecture family, just in case additional related architectures are created later.   * Use your modified rebootstrap, the other patches and manual [[DebianBootstrap|bootstrapping]] to build all of build-essential.
Line 41: Line 42:
Monitor build failures ([[https://buildd.debian.org/status/architecture.php|1]] [[https://udd.debian.org/cgi-bin/ftbfs.cgi|2]]) and continually fix issues.   * Keep working on the bootstrap process until all of build-essential is installable with debootstrap.
Line 43: Line 44:
Donate hardware for the [[https://gcc.gnu.org/wiki/CompileFarm|GCC compile farm]].   * Continue building as many packages as you can using the new build-essential packages.
Line 45: Line 46:
Setup porterboxen for package maintainers to login to and port packages.   * Get any remaining changes included into the upstream projects that you have modified.
Line 47: Line 48:
Optionally, donate hardware for [[https://debomatic.github.io/|debomatic]].   * Get any necessary changes included into rebootstrap and other projects involved in the bootstrap process.
Line 49: Line 50:
Port the [[https://www.debian.org/devel/debian-installer/|Debian installer]] so that it works on the hardware you have available. = Unofficial port =
Line 51: Line 52:
Use the Debian installer to install Debian on the hardware you have available.   * [[Ports|Register the port]] on the Debian wiki, replace "example" throughout the page with the chosen architecture details and fill out as many details as you have.
Line 53: Line 54:
Write some [[https://wiki.debian.org/InstallingDebianOn|documentation about installing the arch on the hardware]] you have installed.   * Summarise the details of the architecture and ABI on the [[ArchitectureSpecificsMemo#Summary|arch summary wiki page]].
Line 55: Line 56:
Submit [[https://www.debian.org/releases/stable/amd64/ch05s04#submit-bug|installation reports]] for the hardware you have installed.   * Setup communication channels for the architecture. Use the architecture family as the name of any communication channels you create, just in case additional related architectures are created later. A [[https://www.debian.org/MailingLists/HOWTO_start_list|mailing list]] and [[IRC#How_to_create_a_new_.23debian-.2A_channel|IRC channel]] are recommended.
Line 57: Line 58:
Submit some [[https://wiki.debian.org/Hardware/Database|hardware probes]] for the hardware you have installed.   * Add your architecture to the [[Teams/Debbugs/ArchitectureTags|bugs arch usertags page]].
Line 59: Line 60:
Grow the hardware ecosystem until it satisfies the [[https://dsa.debian.org/ports/hardware-requirements/|requirements for an official port]].   * [[https://www.ports.debian.org/contacts|Get]] the port included amongst the unofficial ports.
Line 61: Line 62:
Improve the port until it satisfies the [[https://ftp-master.debian.org/archive-criteria.html|criteria for being included in the main archive]].   * [[https://www.debian.org/devel/buildd/|Setup unofficial buildd servers]] for the port, either in qemu or hardware.
Line 63: Line 64:
Donate hardware for the official buildds and co-ordinate with [[Teams/DSA|the Debian sysadmins]] to setup the hardware in Debian hosting locations.   * Include the port on the [[https://www.debian.org/ports/|ports list on the Debian website]] and add the end-user name for the port to the [[https://salsa.debian.org/webmaster-team/webwml/-/blob/master/english/releases/arches.data|website arches data]]. If you create a page on the website, create one named after the architecture family, just in case additional related architectures are created later.
Line 65: Line 66:
Add quality assurance for the port for [[https://reproducible-builds.org/|Reproducible Builds]], [[https://ci.debian.net/doc/|Debian CI]], and [[https://piuparts.debian.org/|piuparts]] (doesn't yet support non-x86 ports) and other [[qa.debian.org|Debian QA efforts]].   * Monitor build failures ([[https://buildd.debian.org/status/architecture.php|1]] [[https://udd.debian.org/cgi-bin/ftbfs.cgi|2]]) and continually fix issues.
Line 67: Line 68:
Add support for the port to the [[https://www.debian.org/devel/debian-live/|live images]] and [[Cloud|cloud]] images if appropriate hardware exists.   * Donate hardware for the [[https://gcc.gnu.org/wiki/CompileFarm|GCC compile farm]].
Line 69: Line 70:
Improve the port until it satisfies the [[https://release.debian.org/testing/arch_policy.html|criteria for being included in a Debian release]].   * Setup porterboxen for package maintainers to login to and port packages.
Line 71: Line 72:
Make the port more performant by porting or optimising various libraries (ToDo: add examples).   * Optionally, donate hardware for [[https://debomatic.github.io/|debomatic]].
Line 73: Line 74:
Make the bootstrap process more trustworthy through [[https://bootstrappable.org/|Bootstrappable Builds]].   * Port the [[https://www.debian.org/devel/debian-installer/|Debian installer]] so that it works on the hardware you have available.

  * Use the Debian installer to install Debian on the hardware you have available.

  * Write some [[https://wiki.debian.org/InstallingDebianOn|documentation about installing the arch on the hardware]] you have installed.

  * Submit [[https://www.debian.org/releases/stable/amd64/ch05s04#submit-bug|installation reports]] for the hardware you have installed.

  * Submit some [[https://wiki.debian.org/Hardware/Database|hardware probes]] for the hardware you have installed.

= Official port =

  * Grow the hardware ecosystem until it satisfies the [[https://dsa.debian.org/ports/hardware-requirements/|requirements for an official port]].

  * Improve the port until it satisfies the [[https://ftp-master.debian.org/archive-criteria.html|criteria for being included in the main archive]].

  * Donate hardware for the official buildds and co-ordinate with [[Teams/DSA|the Debian sysadmins]] to setup the hardware in Debian hosting locations.

  * Add quality assurance for the port for [[https://reproducible-builds.org/|Reproducible Builds]], [[https://ci.debian.net/doc/|Debian CI]], and [[https://piuparts.debian.org/|piuparts]] (doesn't yet support non-x86 ports) and other [[qa.debian.org|Debian QA efforts]].

  * Add support for the port to the [[https://www.debian.org/devel/debian-live/|live images]] and [[Cloud|cloud]] images if appropriate hardware exists.

= Released port =

  * Improve the port until it satisfies the [[https://release.debian.org/testing/arch_policy.html|criteria for being included in a Debian release]].

= Other work =

  * Improve the port based on reports from users and QA services.

  * Make the port more performant by porting or optimising various libraries (ToDo: add examples).

  * Make the bootstrap process more trustworthy through [[https://bootstrappable.org/|Bootstrappable Builds]].

This page documents the approximate procedure for creating a new port and getting it included into Debian. It is a work in progress and is based on the port template wiki page.

/!\ Do not skip any of the steps.

/!\ Complete each step before moving to later steps.

Preparation

  • Assemble a team of people working on the port and find a financial sponsor to support the team's work.
  • Register accounts for each team member on the bug trackers and subscribe to the mailing lists for the upstream kernel (such as Linux), GNU config, binutils, gcc, gdb, qemu, glibc projects.

Upstreaming

Downstreaming

  • Identify related ports and ISAs, decide that the port is worth creating and detail the reasons why.
  • Register accounts for each team member on the Debian wiki (registration) and Salsa (register).

  • Register and verify accounts for each team member on the OFTC IRC chat network and join the #debian-bootstrap, #debian-ports and other Debian IRC channels.

  • Discuss the port with the community. Please send an email to the FIXME mailing list. If the port is related to some other architectures, ensure you CC the mailing list for the architecture family. Also join the #debian-bootstrap and #debian-ports IRC channels.

  • Finalise the architecture details, especially including the ABI and CPU baseline requirements.
  • Get any necessary changes included into dpkg (instructions), to get the new Debian architecture name supported (which is the name that end-users will use for the architecture), this requires having the

Bootstrap

  • Prepare patches supporting the port in rebootstrap and other Debian-specific packages.

  • Use your modified rebootstrap, the other patches and manual bootstrapping to build all of build-essential.

  • Keep working on the bootstrap process until all of build-essential is installable with debootstrap.
  • Continue building as many packages as you can using the new build-essential packages.
  • Get any remaining changes included into the upstream projects that you have modified.
  • Get any necessary changes included into rebootstrap and other projects involved in the bootstrap process.

Unofficial port

  • Register the port on the Debian wiki, replace "example" throughout the page with the chosen architecture details and fill out as many details as you have.

  • Summarise the details of the architecture and ABI on the arch summary wiki page.

  • Setup communication channels for the architecture. Use the architecture family as the name of any communication channels you create, just in case additional related architectures are created later. A mailing list and IRC channel are recommended.

  • Add your architecture to the bugs arch usertags page.

  • Get the port included amongst the unofficial ports.

  • Setup unofficial buildd servers for the port, either in qemu or hardware.

  • Include the port on the ports list on the Debian website and add the end-user name for the port to the website arches data. If you create a page on the website, create one named after the architecture family, just in case additional related architectures are created later.

  • Monitor build failures (1 2) and continually fix issues.

  • Donate hardware for the GCC compile farm.

  • Setup porterboxen for package maintainers to login to and port packages.
  • Optionally, donate hardware for debomatic.

  • Port the Debian installer so that it works on the hardware you have available.

  • Use the Debian installer to install Debian on the hardware you have available.
  • Write some documentation about installing the arch on the hardware you have installed.

  • Submit installation reports for the hardware you have installed.

  • Submit some hardware probes for the hardware you have installed.

Official port

Released port

Other work

  • Improve the port based on reports from users and QA services.
  • Make the port more performant by porting or optimising various libraries (ToDo: add examples).

  • Make the bootstrap process more trustworthy through Bootstrappable Builds.