summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMary Ruthven <mruthven@chromium.org>2021-01-05 16:41:40 -0800
committerCommit Bot <commit-bot@chromium.org>2021-01-06 23:07:17 +0000
commit2fc8fe4b2cac0e9b5d5a12fb3c6ed9cbba075ad7 (patch)
treedff146c1df113652f80e20b8a48dd4f0c88384e3
parent8e2fef04486018e1aed1f3c13b6ac763251b1e71 (diff)
downloadchrome-ec-2fc8fe4b2cac0e9b5d5a12fb3c6ed9cbba075ad7.tar.gz
coil: use links to the main branch in docs
BUG=b:175244613 TEST=make buildall -j Change-Id: I70b2374985aeefb3550e529dcdc53a9ab2fffecb Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2613453 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
-rw-r--r--README.md18
-rw-r--r--docs/ap-ec-comm.md2
-rw-r--r--docs/case_closed_debugging.md8
-rw-r--r--docs/case_closed_debugging_cr50.md24
-rw-r--r--docs/ccd_howtos.md4
-rw-r--r--docs/ec_terms.md4
-rw-r--r--docs/getting_started_quickly.md2
-rw-r--r--navbar.md4
8 files changed, 33 insertions, 33 deletions
diff --git a/README.md b/README.md
index 5826343909..c35987cbdb 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ The Chromium OS project includes open source software for embedded controllers
(EC) used in recent ARM and x86 based Chromebooks. This software includes a
lightweight, multitasking OS with modules for power sequencing, keyboard
control, thermal control, battery charging, and verified boot. The EC software
-is written in C and supports [a variety of micro-controllers](https://chromium.googlesource.com/chromiumos/platform/ec/+/master/chip/).
+is written in C and supports [a variety of micro-controllers](https://chromium.googlesource.com/chromiumos/platform/ec/+/main/chip/).
This document is a guide to help make you familiar with the EC code, current
features, and the process for submitting code patches.
@@ -116,7 +116,7 @@ Each Chrome device has a firmware branch created when the read-only firmware is
locked down prior to launch. This is done so that updates can be made to the
read-write firmware with a minimal set of changes from the read-only. Some
Chrome devices only have build targets on firmware branches and not on
-cros/master. Run “`git branch -a | grep firmware`” to locate the firmware branch
+cros/main. Run “`git branch -a | grep firmware`” to locate the firmware branch
for your board. Note that for devices still under development, the board
configuration may be on the branch for the platform reference board.
@@ -150,11 +150,11 @@ branch1...branch2 as needed):
git log --left-right --graph --cherry-pick --oneline branch1...branch2
```
-For example, to see the difference between cros/master and the HEAD of the
+For example, to see the difference between cros/main and the HEAD of the
current branch:
```bash
-git log --left-right --graph --cherry-pick --oneline cros/master...HEAD
+git log --left-right --graph --cherry-pick --oneline cros/main...HEAD
# Note: Use three dots “...” or it won’t work!
```
@@ -204,7 +204,7 @@ The generated EC binary from emerge is found at:
```
The ebuild file used by Chromium OS is found
-[here](https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/master/chromeos-base/chromeos-ec/chromeos-ec-9999.ebuild):
+[here](https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/main/chromeos-base/chromeos-ec/chromeos-ec-9999.ebuild):
```bash
(chroot) $ ~/trunk/src/third_party/chromiumos-overlay/chromeos-base/chromeos-ec/chromeos-ec-9999.ebuild
@@ -287,7 +287,7 @@ This turns on the following flags:
* `GBB_FLAG_DISABLE_EC_SOFTWARE_SYNC`
The `GBB` (Google Binary Block) flags are defined in the
-[vboot_reference source](https://chromium.googlesource.com/chromiumos/platform/vboot_reference/+/master/firmware/include/gbb_header.h).
+[vboot_reference source](https://chromium.googlesource.com/chromiumos/platform/vboot_reference/+/main/firmware/include/gbb_header.h).
A varying subset of these flags are implemented and/or relevant for any
particular board.
@@ -388,7 +388,7 @@ in priority order if more than one callback needs to be run. There are also
hooks for running functions periodically: `HOOK_TICK` (fires every
`HOOK_TICK_INVERVAL` ms which varies by EC chip) and `HOOK_SECOND`. See
hook_type in
-[include/hooks.h](https://chromium.googlesource.com/chromiumos/platform/ec/+/master/include/hooks.h)
+[include/hooks.h](https://chromium.googlesource.com/chromiumos/platform/ec/+/main/include/hooks.h)
for a complete list.
### Deferred Functions
@@ -429,7 +429,7 @@ void some_interrupt(enum gpio_signal signal)
While there is no heap, there is a shared memory buffer that can be borrowed
temporarily (ideally before a context switch). The size of the buffer depends on
the EC chip being used. The buffer can only be used by one task at a time. See
-[common/shared_mem.c](https://chromium.googlesource.com/chromiumos/platform/ec/+/master/common/shared_mem.c)
+[common/shared_mem.c](https://chromium.googlesource.com/chromiumos/platform/ec/+/main/common/shared_mem.c)
for more information. At present (May 2014), this buffer is only used by debug
commands.
@@ -460,7 +460,7 @@ Other style notes:
not use globals to pass information between modules without accessors. For
module scope, accessors are not needed.
1. If you add a new `#define` config option to the code, please document it in
- [include/config.h](https://chromium.googlesource.com/chromiumos/platform/ec/+/master/include/config.h)
+ [include/config.h](https://chromium.googlesource.com/chromiumos/platform/ec/+/main/include/config.h)
with an `#undef` statement and descriptive comment.
1. The Chromium copyright header must be included at the top of new files in
all contributions to the Chromium project:
diff --git a/docs/ap-ec-comm.md b/docs/ap-ec-comm.md
index 8b6b5abe41..0fc31b6822 100644
--- a/docs/ap-ec-comm.md
+++ b/docs/ap-ec-comm.md
@@ -149,5 +149,5 @@ after receiving a host packet and before it has a response ready.
[`cros-ec` Kernel driver]: https://chromium.googlesource.com/chromiumos/third_party/kernel/+/refs/heads/chromeos-4.19/drivers/mfd/cros_ec_dev.c
[Industrial I/O]: https://www.kernel.org/doc/html/v4.14/driver-api/iio/index.html
-[host command task]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/common/host_command.c
+[host command task]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/main/common/host_command.c
[Transport-specific details]: #Transport_specific-details
diff --git a/docs/case_closed_debugging.md b/docs/case_closed_debugging.md
index ab6202af92..693d1082e1 100644
--- a/docs/case_closed_debugging.md
+++ b/docs/case_closed_debugging.md
@@ -218,9 +218,9 @@ See the [`SERVO_PID_DEFAULTS`] in the servo code for all values.
1. Software sync from the AP has replaced the PD firmware with a version that
is not compatible with case closed debugging.
-[`servo_v4`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo_v4.md
-[`servo_v2`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo_v2.md
-[`servo_micro`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo_micro.md
+[`servo_v4`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo_v4.md
+[`servo_v2`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo_v2.md
+[`servo_micro`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo_micro.md
[Cr50 CCD]: ./case_closed_debugging_cr50.md
-[Suzy-Q]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/ccd.md#suzyq-suzyqable
+[Suzy-Q]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/ccd.md#suzyq-suzyqable
[`SERVO_PID_DEFAULTS`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/ff8e96686ef3d9ad2e26125ca8268cb7f7666f6c/servo/interface/ftdi_common.py#28
diff --git a/docs/case_closed_debugging_cr50.md b/docs/case_closed_debugging_cr50.md
index 0e244c15a0..5a71bc42ad 100644
--- a/docs/case_closed_debugging_cr50.md
+++ b/docs/case_closed_debugging_cr50.md
@@ -798,15 +798,15 @@ Chrome OS is installed, AP flash can be updated to include the rest of the image
by running [`flashrom`] or `futility` from the device bash prompt.
[Case Closed Debugging]: ./case_closed_debugging.md
-[chromeos-cr50 ebuild]: https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/refs/heads/master/chromeos-base/chromeos-cr50/chromeos-cr50-0.0.1.ebuild
-[Developer Mode]: https://chromium.googlesource.com/chromiumos/docs/+/master/developer_mode.md#dev-mode
-[Recovery Mode]: https://chromium.googlesource.com/chromiumos/docs/+/master/debug_buttons.md
-[Servo]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo.md
-[`servod`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo.md
-[Type-C Servo v4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo_v4.md
-[update servo v4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/servo_v4.md#updating-firmware
-[Suzy-Q]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/master/docs/ccd.md#SuzyQ-SuzyQable
-[`hdctools`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/master/README.md
+[chromeos-cr50 ebuild]: https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/refs/heads/main/chromeos-base/chromeos-cr50/chromeos-cr50-0.0.1.ebuild
+[Developer Mode]: https://chromium.googlesource.com/chromiumos/docs/+/main/developer_mode.md#dev-mode
+[Recovery Mode]: https://chromium.googlesource.com/chromiumos/docs/+/main/debug_buttons.md
+[Servo]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo.md
+[`servod`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo.md
+[Type-C Servo v4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo_v4.md
+[update servo v4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/servo_v4.md#updating-firmware
+[Suzy-Q]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/main/docs/ccd.md#SuzyQ-SuzyQable
+[`hdctools`]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/main/README.md
[`FlashAP`]: #flashap
[flashing the AP firmware]: #flashap
[flashap]: #flashap
@@ -824,10 +824,10 @@ by running [`flashrom`] or `futility` from the device bash prompt.
[cap]: #cap
[consoles]: #consoles
[hw-wp]: #hw-wp
-[`flash_ec`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/master/util/flash_ec
+[`flash_ec`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/main/util/flash_ec
[CCD Open]: #ccd-open
-[`flashrom`]: https://chromium.googlesource.com/chromiumos/third_party/flashrom/+/master/README.chromiumos
+[`flashrom`]: https://chromium.googlesource.com/chromiumos/third_party/flashrom/+/main/README.chromiumos
[speed up the flashing process]: #speed-up-ap-flash
[this bug]: https://issuetracker.google.com/149420712
[semver]: https://semver.org/
-[`usb_console`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/master/extra/usb_serial/console.py
+[`usb_console`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/main/extra/usb_serial/console.py
diff --git a/docs/ccd_howtos.md b/docs/ccd_howtos.md
index 93d272e1b5..309a3b73b8 100644
--- a/docs/ccd_howtos.md
+++ b/docs/ccd_howtos.md
@@ -378,7 +378,7 @@ It goes into a lot more detail.
[enter dev mode]: ./case_closed_debugging_cr50.md#enter-dev-mode
[sparkfun]: https://www.sparkfun.com/products/14746
[Setup CCD]: ./case_closed_debugging_cr50.md#CCD-Setup
-[SuzyQ]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/master/docs/ccd.md#suzyq-suzyqable
-[Type-C Servo V4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/master/docs/servo_v4.md
+[SuzyQ]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/main/docs/ccd.md#suzyq-suzyqable
+[Type-C Servo V4]: https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/refs/heads/main/docs/servo_v4.md
[wp console command]: ./case_closed_debugging_cr50.md#WP-control
diff --git a/docs/ec_terms.md b/docs/ec_terms.md
index fb6d42619c..8c3e4e2f48 100644
--- a/docs/ec_terms.md
+++ b/docs/ec_terms.md
@@ -169,10 +169,10 @@
[BC 1.2 Specification]: <https://www.usb.org/document-library/battery-charging-v12-spec-and-adopters-agreement>
-[CrOS Board Info]: <https://chromium.googlesource.com/chromiumos/docs/+/master/design_docs/cros_board_info.md>
+[CrOS Board Info]: <https://chromium.googlesource.com/chromiumos/docs/+/main/design_docs/cros_board_info.md>
[CEC Wikipedia page]: <https://en.wikipedia.org/wiki/Consumer_Electronics_Control>
[DPTF Readme]: <https://github.com/intel/dptf/blob/master/README.txt>
[eSPI Specification]: <https://www.intel.com/content/dam/support/us/en/documents/software/chipset-software/327432-004_espi_base_specification_rev1.0.pdf>
[I2C Specification]: <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>
[RS-232]: <https://en.wikipedia.org/wiki/RS-232>
-[EC MKBP driver]: <https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/common/keyboard_mkbp.c>
+[EC MKBP driver]: <https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/main/common/keyboard_mkbp.c>
diff --git a/docs/getting_started_quickly.md b/docs/getting_started_quickly.md
index 9b22dc64c7..aa80fb683b 100644
--- a/docs/getting_started_quickly.md
+++ b/docs/getting_started_quickly.md
@@ -3,7 +3,7 @@
[TOC]
The
-[Chromium OS Developer Guide](https://chromium.googlesource.com/chromiumos/docs/+/master/developer_guide.md)
+[Chromium OS Developer Guide](https://chromium.googlesource.com/chromiumos/docs/+/main/developer_guide.md)
and [README](../README.md) walk through the steps needed to fetch and build
Chromium OS source. These steps can be followed to retrieve and build EC source
as well. On the other hand, if your sole interest is building an EC image, the
diff --git a/navbar.md b/navbar.md
index 4564552a64..03b7172030 100644
--- a/navbar.md
+++ b/navbar.md
@@ -7,5 +7,5 @@
* [Documentation](/docs/sitemap.md)
* [Getting Started Quickly](/docs/getting_started_quickly.md)
* [File a Bug](https://bugs.chromium.org/p/chromium/issues/entry?components=OS%3EFirmware%3EEC)
-* [Report Security Issue](https://chromium.googlesource.com/chromiumos/docs/+/master/reporting_bugs.md#security)
-* [Chromium OS Docs](https://chromium.googlesource.com/chromiumos/docs/+/master/README.md)
+* [Report Security Issue](https://chromium.googlesource.com/chromiumos/docs/+/main/reporting_bugs.md#security)
+* [Chromium OS Docs](https://chromium.googlesource.com/chromiumos/docs/+/main/README.md)