From b3f5d94f0957f20422e6095cf049808ddbb37520 Mon Sep 17 00:00:00 2001 From: Stefan Reinauer Date: Thu, 14 Sep 2023 12:47:26 -0700 Subject: Documentation: Adjust master -> main branch Some of our documentation still points to the wrong branches Change-Id: Idb72e4f44f294f64eb01c588027d300a53d6fb41 Signed-off-by: Stefan Reinauer Reviewed-on: https://review.coreboot.org/c/coreboot/+/77875 Reviewed-by: Patrick Georgi Tested-by: build bot (Jenkins) --- Documentation/contributing/gerrit_guidelines.md | 10 +++++----- Documentation/corebootBuildingGuide.tex | 16 ++++++++-------- Documentation/index.md | 6 +++--- Documentation/infrastructure/builders.md | 6 +++--- Documentation/lib/fw_config.md | 4 ++-- Documentation/lib/payloads/fit.md | 2 +- Documentation/tutorial/part2.md | 2 +- 7 files changed, 23 insertions(+), 23 deletions(-) (limited to 'Documentation') diff --git a/Documentation/contributing/gerrit_guidelines.md b/Documentation/contributing/gerrit_guidelines.md index c6f5fbfebf90..9b0cc5f91eb3 100644 --- a/Documentation/contributing/gerrit_guidelines.md +++ b/Documentation/contributing/gerrit_guidelines.md @@ -234,7 +234,7 @@ be set when you push the patches into gerrit. For example, to push a set of commits with the i915-kernel-x60 set, use the command: ```Bash -git push origin HEAD:refs/for/master%topic=i915-kernel-x60 +git push origin HEAD:refs/for/main%topic=i915-kernel-x60 ``` * If one of your patches isn't ready to be merged, make sure it's obvious @@ -247,7 +247,7 @@ isn't as obvious as the commit message. These patches can also be pushed with the wip flag: ```Bash -git push origin HEAD:refs/for/master%wip +git push origin HEAD:refs/for/main%wip ``` * When pushing patches that are not for submission, these should be marked @@ -259,13 +259,13 @@ who knows their commit ID, so don't use this for sensitive changes. To push a private change, use the command: ```Bash -git push origin HEAD:refs/for/master%private +git push origin HEAD:refs/for/main%private ``` * Multiple push options can be combined: ```Bash -git push origin HEAD:refs/for/master%private,wip,topic=experiment +git push origin HEAD:refs/for/main%private,wip,topic=experiment ``` * Respond to anyone who has taken the time to review your patches, even if @@ -292,7 +292,7 @@ changed. helps others and shows that these mainboards are currently being maintained. At some point, boards that are not up to date in the board-status repo will probably end up getting removed from the coreboot -master branch. +main branch. * Abandon patches that are no longer useful, or that you don’t intend to keep working on to get submitted. diff --git a/Documentation/corebootBuildingGuide.tex b/Documentation/corebootBuildingGuide.tex index 9acfd18e38c8..32918e8a82c7 100644 --- a/Documentation/corebootBuildingGuide.tex +++ b/Documentation/corebootBuildingGuide.tex @@ -386,7 +386,7 @@ want to submit all commits in the currently checked-out branch for review on gerrit: { \small \begin{verbatim} -$ git config remote.origin.push HEAD:refs/for/master +$ git config remote.origin.push HEAD:refs/for/main \end{verbatim} } @@ -399,10 +399,10 @@ $ make gitconfig \subsection{Work flow} -It is recommended that you make a new branch when you start to work, not pushing changes to master. +It is recommended that you make a new branch when you start to work, not pushing changes to main. { \small \begin{verbatim} -$ git checkout master -b mybranch +$ git checkout main -b mybranch \end{verbatim} } After you have done your changes, run: @@ -452,7 +452,7 @@ make a new local commit that fixes the issues reported by the reviewers, then rebase the change by preserving the same Change-ID. We recommend you to use the git rebase command in interactive mode, -Once your patch gets a +2 comment, your patch can be merged (cherry-pick, actually) to origin/master. +Once your patch gets a +2 comment, your patch can be merged (cherry-pick, actually) to origin/main. % % Working with Gerrit @@ -474,9 +474,9 @@ click \url{https://review.coreboot.org} |Search for status:open | +-----------------------------------------------------------+ |Subject Status Owner Project Branch Updated CR V | -|cpu: Rename.. Alexandru coreboot master 1:20 PM +1 | -|cpu: Only a.. Alexandru coreboot master 1:17 PM X | -|arch/x86: D.. Alexandru coreboot master 1:09 PM | +|cpu: Rename.. Alexandru coreboot main 1:20 PM +1 | +|cpu: Only a.. Alexandru coreboot main 1:17 PM X | +|arch/x86: D.. Alexandru coreboot main 1:09 PM | | | | Next -> | |Press '?' to view keyboard shortcuts | Powered by Gerrit | @@ -637,7 +637,7 @@ Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer. Gerrit simplifies Git based project maintainership by permitting any -authorized user to submit changes to the master Git repository, rather +authorized user to submit changes to the upstream Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer. This functionality enables a more centralized usage of Git. diff --git a/Documentation/index.md b/Documentation/index.md index 5d4c680715bc..6d91aa016873 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -146,9 +146,9 @@ coreboot is primarily developed in the system, using [Gerrit](https://review.coreboot.org) to manage contributions and code review. -In general we try to keep the `master` branch in the repository functional +In general we try to keep the `main` branch in the repository functional for all hardware we support. So far, the only guarantee we can make is -that the master branch will (nearly) always build for all boards in a +that the main branch will (nearly) always build for all boards in a standard configuration. However, we're continually working on improvements to our infrastructure to @@ -200,4 +200,4 @@ Contents: * [External Resources](external_docs.md) * [Documentation License](documentation_license.md) -[Documentation]: https://review.coreboot.org/plugins/gitiles/coreboot/+/refs/heads/master/Documentation/ +[Documentation]: https://review.coreboot.org/plugins/gitiles/coreboot/+/refs/heads/main/Documentation/ diff --git a/Documentation/infrastructure/builders.md b/Documentation/infrastructure/builders.md index f2dbc11b8751..f37fabf5b3fd 100644 --- a/Documentation/infrastructure/builders.md +++ b/Documentation/infrastructure/builders.md @@ -74,7 +74,7 @@ These times are taken from the week of Feb 21 - Feb 28, 2022 There are a number of builds handled by the coreboot jenkins builders, for a number of different projects - coreboot, flashrom, memtest86+, -em100, etc. Many of these have builders for their current master branch +em100, etc. Many of these have builders for their current main branch as well as Gerrit and [Coverity](coverity.md) builds. @@ -91,14 +91,14 @@ machines. These tasks run overnight in the US timezones. You can see all the builds in the main jenkins interface: [https://qa.coreboot.org/](https://qa.coreboot.org/) -Most of the time on the builders is taken up by the coreboot master and +Most of the time on the builders is taken up by the coreboot main and coreboot gerrit builds. * [coreboot gerrit build](https://qa.coreboot.org/job/coreboot-gerrit/) ([Time trend](https://qa.coreboot.org/job/coreboot-gerrit/buildTimeTrend)) -* [coreboot master build](https://qa.coreboot.org/job/coreboot/) +* [coreboot main build](https://qa.coreboot.org/job/coreboot/) ([Time trend](https://qa.coreboot.org/job/coreboot/buildTimeTrend)) diff --git a/Documentation/lib/fw_config.md b/Documentation/lib/fw_config.md index fc33d9570289..884ba3f23733 100644 --- a/Documentation/lib/fw_config.md +++ b/Documentation/lib/fw_config.md @@ -106,8 +106,8 @@ protection)* with the `ectool` command in a ChromeOS environment. For more information on the firmware configuration field on ChromeOS devices see the Chromium documentation for [Firmware Config][1] and [Board Info][2]. -[1]: http://chromium.googlesource.com/chromiumos/docs/+/master/design_docs/firmware_config.md -[2]: http://chromium.googlesource.com/chromiumos/docs/+/master/design_docs/cros_board_info.md +[1]: http://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/firmware_config.md +[2]: http://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md ## Firmware Configuration Table diff --git a/Documentation/lib/payloads/fit.md b/Documentation/lib/payloads/fit.md index ac3c18341a7c..9163cddeed45 100644 --- a/Documentation/lib/payloads/fit.md +++ b/Documentation/lib/payloads/fit.md @@ -180,5 +180,5 @@ The generated file includes a compressed initrd **initramfs.cpio.xz**, which will be decompressed by the Linux kernel, a compressed kernel **Image.lzma**, which will be decompressed by the FIT loader and an uncompressed devicetree blob. -[uImage.FIT]: https://raw.githubusercontent.com/u-boot/u-boot/master/doc/uImage.FIT/howto.txt +[uImage.FIT]: https://github.com/u-boot/u-boot/blob/master/doc/usage/fit/howto.rst [U-Boot]: https://www.denx.de/wiki/U-Boot diff --git a/Documentation/tutorial/part2.md b/Documentation/tutorial/part2.md index 5917ed4d2b5b..7c8ce9eb522b 100644 --- a/Documentation/tutorial/part2.md +++ b/Documentation/tutorial/part2.md @@ -166,7 +166,7 @@ commit --amend` allows you to take back your commit and amend it. When you are done with your commit, run `git push` to push your commit to coreboot.org. **Note:** To submit as a private patch, use `git push -origin HEAD:refs/for/master%private`. Submitting as a private patch +origin HEAD:refs/for/main%private`. Submitting as a private patch means that your commit will be on review.coreboot.org, but is only visible to yourself and those you add as reviewers. This mode isn't perfect: Somebody who knows the commit ID can still fetch the change and -- cgit v1.2.3