Commit Graph

8 Commits

Author SHA1 Message Date
Rob Mohr
895d3df23c pw_env_setup: Change how files are passed in
Change how files are passed into pw_env_setup. In most cases they're
passed in with --use-pigweed-defaults, but downstream projects now have
the option to not include Pigweed's defaults.

Change-Id: I82383705e156be14276a8498648ca376e3340efb
Bug: 274
Requires: pigweed-internal:7120
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19380
Commit-Queue: Rob Mohr <mohrr@google.com>
Reviewed-by: Joe Ethier <jethier@google.com>
Reviewed-by: Michael Spang <spang@google.com>
2020-10-15 13:31:04 +00:00
Wyatt Hepler
f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00
Michael Spang
bb2bc72fcb Skip pigweed requirements.txt if overridden
Pigweed uses exact versions of packages that may conflict with
downstream requirements. Skip them by default and add an option
PW_VIRTUALENV_REQUIREMENTS_APPEND_DEFAULT to allow re=adding the default
requirements.txt.

Change-Id: Idf6b6b47ae8a6bdfc5dbf1e948a63d2070d8285a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/18861
Commit-Queue: Michael Spang <spang@google.com>
Reviewed-by: Rob Mohr <mohrr@google.com>
2020-09-25 22:49:51 +00:00
Rob Mohr
43d3611ad7 pw_env_setup: Expand docs
Change-Id: If4dd259a99679f9f5fead49780120adb84d72375
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/17743
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Rob Mohr <mohrr@google.com>
2020-09-11 21:34:21 +00:00
Rob Mohr
ce87bc01d8 pw_env_setup: allow setting environment directory
Allow setting of environment installation directory. Everything created
from environment setup gets installed into this directory.

The first time bootstrap is run after this commit is applied will take
longer, and eventually the old paths should be removed from .gitignore
(and deleted).

Bug: 216
Change-Id: I92ebe8a2414998cb5e4ae9ef3a92d6b50ffa8fab
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/13600
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Rob Mohr <mohrr@google.com>
2020-07-16 17:10:34 +00:00
Rob Mohr
d596a539ee pw_env_setup: use env vars for bootstrap opts
The following environment variables are now used to pass options into
pw_env_setup:

* PW_CIPD_PACKAGEFILES
* PW_VIRTUALENV_REQUIREMENTS
* PW_VIRTUALENV_SETUPPYROOTS
* PW_CARGO_PACKAGEFILES

Each of these variables can contain multiple entries separated by ':'
(or ';' on Windows) like PATH. However, they will also be interpreted
as globs, so PW_VIRTUALENV_REQUIREMENTS="/foo/bar/*/requirements.txt"
is perfectly valid. They should be full paths.

Projects depending on Pigweed should prepend to these variables and
then invoke Pigweed's bootstrap.sh (or bootstrap.bat). Users wanting
additional setup should set these variables in their shell init files.

Change-Id: Ibf0f1d5279028856a590ffc50850df2174c38e28
Bug: 138
2020-04-03 08:59:12 -07:00
Armando Montanez
0054a9be70 Docs: Add missing RST docs
Adds dcos.rst files for all modules lacking documentation.

Change-Id: Ief5594831d31fcb876381a4a3886382fab7d595e
2020-03-17 00:13:35 +00:00
Rob Mohr
d45e2343cb Add docs for pw_env_setup
Change-Id: Ie97a18499040bba4e0061dfa192e81f617c68c9e
2020-03-03 15:02:18 -08:00