Commit graph

15 commits

Author SHA1 Message Date
Junichi Uekawa
63d127f45c crosvm: Merge README.chromeos to CONTRIBUTING.
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>
2022-01-26 01:33:23 +00:00
Dennis Kempin
82f9987349 Remove uprev section from CONTRIBUTING.md
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>
2021-12-16 06:26:53 +00:00
Junichi Uekawa
8ed082e917 crosvm: Add link to the chromeos-base/crosvm topic.
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>
2021-11-30 09:23:55 +00:00
Junichi Uekawa
67e9fe7372 crosvm: Document the pupr process.
'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>
2021-11-24 06:37:00 +00:00
Keiichi Watanabe
73b68faf7f CONTRIBUTING: Add more instruction on use of mdbook command
BUG=none
TEST=check rendered results

Change-Id: I10532c45317f5189bd867850f36e7ae93b4abcc4
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3252187
Auto-Submit: Keiichi Watanabe <keiichiw@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-11-01 15:32:26 +00:00
Keiichi Watanabe
787e5c3dcc CONTRIBUTING: Add a guide for contributing to the book
BUG=b:199687531
TEST=check rendered result

Change-Id: I1fcb4bb2853658866a599394d54d344d4ebc2e50
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3250154
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-10-29 03:21:07 +00:00
Keiichi Watanabe
4ca0429e8d CONTRIBUTING: Add a link to crbug
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>
2021-10-26 05:07:00 +00:00
Keiichi Watanabe
feb0e8d728 CONTRIBUTING: Add code submit workflow
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>
2021-10-26 05:06:59 +00:00
Keiichi Watanabe
0851e14a2b CONTRIBUTING: Add Contributor License Agreement
See go/releasing/preparing#CONTRIBUTING for the detail.

BUG=none
TEST=none

Change-Id: I1fd6ad8da2fdd447d71acc383e1f388f21726710
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3241902
Auto-Submit: Keiichi Watanabe <keiichiw@chromium.org>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
2021-10-25 19:23:42 +00:00
Keiichi Watanabe
d38a34c038 docs: Move code map to ARCHITECTURE
BUG=b:195003973
TEST=none

Change-Id: Idfe9565354d661361010df91c83a9313d94462b2
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188674
Commit-Queue: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-29 16:19:51 +00:00
Keiichi Watanabe
7e68e485ca mdbook: Add "Code Overview" section to CONTRIBUTING.md
Move `Code Overview`  section from README to CONTRIBUTING.md

BUG=b:199874828
TEST=mdbook build

Change-Id: Id3947f958d31816f4fc802a1a35177c0ceafa4dd
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3159889
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2021-09-20 12:45:45 +00:00
Dennis Kempin
a88cb19890 Add kokoro information to CONTRIBUTING.md
Change-Id: I094b90c10f5a60b7f7dfe594e2f9242abad2d18f
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2864374
Tested-by: Dennis Kempin <denniskempin@google.com>
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
2021-04-30 21:56:56 +00:00
Dennis Kempin
4f41c7ebc7 crosvm: Remove old test infrastructure
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>
2021-03-03 07:05:03 +00:00
Daniel Verkamp
fb54f3ccd9 docs: update chromium docs URLs to HEAD branch
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>
2020-12-16 22:53:27 +00:00
Zach Reizner
f9fc42376a flesh out high level documentation
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>
2020-01-22 19:10:45 +00:00