CONTRIBUTION.md instructs contributors to run a 'git checkout' instruction to switch to a new branch to make their changes. The old instruction used the --branch flag to specify the branch when -b really should have been used. Running the old command causes git to return an error.
Change-Id: I4a19592c59566e814fd5c16d900af568c32412ea
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4748941
Commit-Queue: Sebastian Hereu <sebastianhereu@google.com>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Having a style guide section separately so people will be able to find
it more easily.
BUG=b:281972799
TEST=mdbook build
Change-Id: I3af92a3c4abe65226c7cdf1028d30e906e0952ed
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4537376
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
At present, if we set up gerrit message hook using `./tool/cl`, there
will appear a usage message. Reader may think they did not install the
message hook successfully.
Add explanation to documentation to explain even the usage messages
appear, the message hook is still successfully installed.
BUG=b:281798401
TEST=mdbook build docs/book
Change-Id: I3be36315e20d79aff58d0777d0c454b42c8c688a
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4520798
Commit-Queue: Yuan Yao <yuanyaogoog@chromium.org>
Reviewed-by: Takaya Saeki <takayas@chromium.org>
Fixed a few nits that have changed and re-ordered to show the thing
people care about first: How to report bugs or contribute code.
BUG=b:270265630
TEST=None
Change-Id: I3a515b92b6b932dc289c30d9844b473899f6d256
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4305344
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
Fix some typos and a few nits.
BUG=None
TEST=cd docs/book/ && mdbook build
Change-Id: I904b9b0286a7ae0a6e8e434896c6bed7c382ac9e
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4205152
Commit-Queue: Elie Kheirallah <khei@google.com>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Update the book to the current guidelines about one import per line and
std/external/crate grouping, and mention the nightly rustfmt options.
BUG=None
TEST=cd docs/book; mdbook build
Change-Id: I601fea4f44bd473b0cffaaa3162c2b324b01927a
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4133831
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
These should be written as ChromeOS and ChromiumOS (without the space)
to match the updated branding. The copyright headers were already
migrated to the new style (https://crrev.com/c/3894243), but there were
some more instances left over.
BUG=None
TEST=tools/cargo-doc
Change-Id: I8c76aea2eb33b2e370ab71ee9b5cc0a4cfd00585
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4129934
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
Document what a good commit message should look like in CONTRIBUTING.md.
BUG=none
TEST=./tools/fmt
Change-Id: I5097efa9650c9659f090553b1ba4171790cc51fd
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3945521
Reviewed-by: Noah Gold <nkgold@google.com>
Reviewed-by: Alexandre Courbot <acourbot@chromium.org>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
The doc was long outdated.
BUG=b:239823229
TEST=None
Change-Id: If324c7b3fe22f03df4307a5eed1002465b5cce4d
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3780867
Auto-Submit: Dennis Kempin <denniskempin@google.com>
Tested-by: Dennis Kempin <denniskempin@google.com>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
This updates all references to chromiumos/platform/crosvm to
crosvm/crosvm.
It will also switch ./tools/cl to upload to the new main repository.
BUG=None
TEST=None
Change-Id: I1f71e5d5de2300e57ace1315cb4553f68533d576
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3760903
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Tested-by: Dennis Kempin <denniskempin@google.com>
mdbook apparently does not support this syntax and just includes the
text in the section title.
BUG=None
TEST=mdbook build
Change-Id: I3dc4ae25e392b1260df59889926eba2044c4adc6
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3749605
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
This change consolidates some of the spread out information about
what ChromeOS developers need to know about crosvms differences to
other ChromeOS projects.
I created a new directory since I would expect a similar guide for
AOSP eventually.
This also adds more documentation on some of the process changes
suggested in go/crosvm-merge-improvements to improve the
stability of the merge process.
BUG=b:227475914
TEST=None
Change-Id: I08111ecd5a937fde22c7d97f342c1cf02f49b02e
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3561886
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
* Remove leading `$`s so that readers can copy and pastes commands more
easily.
* Use `sh` instead of `bash` because `bash` is for scripts rather than
command line interfaces.
These rules are ones used in mdBook's instruction.
https://github.com/rust-lang/mdBook/tree/master/guide/src/guide
BUG=none
TEST=mdbook build
Change-Id: I3b35fa2c7b20ef10e3da78a47f41a1603744daf0
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3423292
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Auto-Submit: Keiichi Watanabe <keiichiw@chromium.org>
The tool is added to ./tools/fmt which will be called during
./tools/presubmit as well as by Kokoro during testing.
This requires a new dev container version to bundle the mdformat
tool in the container.
Note: mdformat does not have any IDE integrations, but the prettier
plugin with prose-wrap enabled and a line length of 100 provides
almost identical results.
BUG=None
TEST=./tools/fmt --check
Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Alexandre Courbot <acourbot@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
Docs are scattered around, and README.chromeos isn't markdown. Merge to
CONTRIBUTING doc and update the relevant parts. Rename to
README.chromeos.md and make it point to the other doc.
BUG=None
TEST=read it.
Change-Id: Ib1df58e1a7c48d6faad71faffc9527da5f3218be
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3405403
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Junichi Uekawa <uekawa@chromium.org>
It's ChromeOS specific and we just added a separate file for that.
BUG=None
TEST=None
Change-Id: I67e77c3d30e4e4bf456677a13130563c57a87464
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3336216
Reviewed-by: Junichi Uekawa <uekawa@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Junichi Uekawa <uekawa@chromium.org>
The topic is reasonably useful to get a feel of how healthy the current
uprev process is.
BUG=None
TEST=read it.
Change-Id: I6dc329fdb7f1bbb7bea47a156cabf3eb76a3ff9a
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3302692
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Junichi Uekawa <uekawa@chromium.org>
'pupr' and 'uprev' are terms that we use quite often, add some documentation.
BUG=None
TEST=read it.
Change-Id: I888d024b0cffabd43beadce0d76a1cc3644a39e3
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3292385
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Junichi Uekawa <uekawa@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Since bug reporting is one of ways to contributing the project, let's
add a section for it in CONTRIBUTING.md.
Also, ran mdformat to the file.
BUG=none
TEST=none
Change-Id: Id09216fe95baa4c2173aa71d19f3a1c96aa57b0d
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3241904
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Explain how to submit a CL for non-Chromium OS developers.
BUG=none
TEST=none
Change-Id: I3ee0e47eac1f0320f4c086a895f91ebf5fbf2d74
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3241903
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
This is replaced by test_all and the new builders for kokoro.
See ci/README.md for details.
BUG=b:178233937
TEST=None
Change-Id: Id8bf721e026e71d9f284f920ef8287beb414c621
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2705292
Tested-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
Reviewed-by: Zach Reizner <zachr@chromium.org>
This makes the links work regardless of the name of the main branch.
BUG=None
TEST=Navigate to the URLs in a browser
Change-Id: I2daaa077e77e923313fecb23e6afde2e951d82a9
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2596050
Reviewed-by: Stephen Barber <smbarber@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
This change adds a CONTRIBUTING.md and some architectural documentation
for people new to submitting code to crosvm.
TEST=check the gittiles markdown
BUG=None
Change-Id: Ib792220ae50329413f487c5d87b29ad3b2f7c59c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2013213
Tested-by: Zach Reizner <zachr@chromium.org>
Reviewed-by: Stephen Barber <smbarber@chromium.org>
Commit-Queue: Stephen Barber <smbarber@chromium.org>
Auto-Submit: Zach Reizner <zachr@chromium.org>
