Change "external" to "extension" in variable names and a config option.
This configuration option is undocumented and it isn't working correctly
anyway, so changing its name won't hurt anything. The next patch will fix its
behavior.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Fix or improve various docstrings so they are usable from Sphinx. Without this
patch, we can't provide API documentation for west from the zephyr docs tree.
Remove comments from the various schema files. We'll move this information into
the zephyr documentation.
Use "extension" instead of "external" in some log messages for consistency with
the final name of the pluggable commands that aren't built-in.
No behavioral changes other than the slightly different printlines.
Fixes: #240
Signed-off-by: Marti Bolivar <marti@foundries.io>
Release which contain a fix for the major issue in relation to
fetching.
The error could appear upon fetching when remotes are changed or force
pushed.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
It has been discovered that in the event that a different remote is
added to manifest file which contains same branches but cannot be
fast forwarded into the local refs space, then a west update will fail
with the error:
! [rejected] <branch> -> refs/west/<branch> (non-fast-forward)
This commit fixes this issue by introducing '-f' when fetching.
This commit has additional test for verifying the fix.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
- Use colors (regardless of config -- this should be fixed to use config
when we merge everything into pypi)
- Align banner output with project.py
- Don't leave a west branch checked out to avoid a warning on first
self update
Fixes: #201
Signed-off-by: Marti Bolivar <marti@foundries.io>
While reviewing logging calls during the most recent extraction of
project.py code into manifest.py, it became clear that the colorized
and "=== '-prefixed _banner() routine was being called way too often.
Clean this up by adding a new _msg() routine that is prefixed with
"--- " and not colorized. This still lets the output stand out from
git output, but doesn't clutter the output.
Conversely, some _banner() calls were missing, such as in the Diff
class. Fix all that up and make the printing more consistent.
While we are here, normalize various project-related printlines to use
{name} as a prefix for most _msg calls related to a project. The path
was already printed where appropriate in a _banner() call that
happened earlier in these cases.
Fixes: #229
Signed-off-by: Marti Bolivar <marti@foundries.io>
This commit is further progress on #191, but doesn't fix it entirely.
West's design has always been to split code into reusable libraries
and commands which wrap them. The extra effort is justified since West
is pluggable by extension commands, which often benefit from being
able to use the library pieces.
Although the code in project.py started out self-contained, it's
gradually being refactored to fit the design.
Continue that by factoring two more features into manifest.py: helpers
for running git commands in a project and formatting strings using
project attributes.
This lets us remove almost all of the wrappers around west.log in a
way that makes the code easier to read. The remaining _inf() is
renamed _banner() to make its purpose clearer.
Delete a fair bit of dead code left over from the older multirepo
commands which were deleted from v0.4.0 while we are here.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Fixes: #231
This commit ensures that zephyr.base will be joined with west_topdir()
when a relative path is used in west config.
The previous solution was using os.path.abspath which would give
different results depending on current location when invoking west
command.
The advantage of allowing relative path in .west/config over requiring
an absolute path, is that it allows a user to rename a project's parent
folders without having to update zephyr.base.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
This commit allows fallback to set zephyr base to point to the project
which has the path zephyr.
If zephyr base in not set in any way and no project has path 'zephyr'
then an error is printed.
Having the fallback mechanism in an independent commit allows to easily
rollback the commit when it is considered that a project always will
have zephyr base defined as part of west installation.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
This commit changes the order of precedence so that environment setting
takes precedence over west config option.
It also introduces a new config file setting, to allow to specify which
setting: environment or configfile that will take precedence.
To simplify search for ZEPHYR_BASE, this setting will now be written to
the local .west/config during init and selfupdate, if non-existing.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
This commit allows fallback to python standard configparser in case
configobj package is not installed.
This allows `west config` to work with existing bootstrappers.
Having the fallback mechanism in an independent commit allows to easily
rollback the commit when it is considered that all has configobj as
part of west installation.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Fixes: #198#213
This commit add the command `west config` for getting and setting of
key - value pairs in:
- Project specific: `<project>/.west/config`
- Global specific: `~/.westconfig`
- System specific, Linux:`/etc/westconfig`
MacOS: `/usr/local/etc/westconfig`
Windows: `%PROGRAMDATA%/west/config`
It also includes corresponding test cases.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
As part of introducing 'west config' command, the current config.py is
renamed into configuration.py in order to have distinct name for each
module as west commands have module named same as command.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Remove trailing whitespace from the format_help() return value. This
prevents an extra blank line from appearing in the west --help output.
Signed-off-by: Marti Bolivar <marti@foundries.io>
On Windows 10, with Python 3.7.1, the following was not working:
west init -l zephyr/
or
west init -l zephyr\
because of the trailing (back)slash being interpreted as an additional
folder and west initializing itself inside the zephyr folder instead of
doing it in the enclosing one.
By normalizing the path we avoid this issue entirely.
Note that this is actually due to a regression that was fixed:
https://bugs.python.org/issue31047
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Fixes: #214
This commit ensures that west built-in commands are still accessible
even if west.yml cannot be found.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Fixes: #218
Using empty string instead of None as None results in error when
instantiating Manifest project as special project.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Fixes: #212
If ZEPHYR_BASE was set in environment, `west init` fails.
This commit ensures `west init` can still run, as long as it is
invoked outside of a west managed project tree.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Since excluding west from an update procedure is limited to a single
command now (west update), clarify that in the code and use a more
explicit flag name.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
A new test compares the output of -h with that of help for all
commands.
In order to be able to test commands other than the project ones,
refactor the helper functions and fixtures into a common conftest.py and
rename the enclosing folder from "project" to "commands".
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Add a new "help" subcommand which prints the help text for any of the
existing commands, by invoking them with "-h".
Signed-off-by: Marti Bolivar <marti@foundries.io>
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
On Windows execv() is asynchronous, leading to an additional
shell being open concurrently with the existing one.
Use Popen() instead, which ensure synchronicity across all
operating systems.
https://bugs.python.org/issue9148https://bugs.python.org/issue19124
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Since the python object is named url_base, this field is getting
frozen via as_dict with an underscore rather than the dash required
by the schema.
Signed-off-by: Andy Doan <andy@foundries.io>
I screwed up the 0.5.3 upload to PyPI. Then I tried to delete it and
re-upload. This turns out to be impossible -- file names can't be
reused even if the package has been deleted.
So 0.5.3 is the point release that never was, unfortunately. 0.5.4
will be the same, but with a different number. Fun times / whoops.
Signed-off-by: Marti Bolivar <marti@foundries.io>
This point release brings changes to the way the west repository is
updated to make it more consistent with the way projects are updated:
both now have refs/heads/manifest-rev refs which track the latest
version fetched from the remote according to the manifest.
Both are also now updated in the same way: the remote is fetched,
manifest-rev is updated to match the new upstream revision, and the
local branch is moved to a detached HEAD at that spot. The
--keep-descendants and --rebase options are available in both cases as
well in the relevant commands (selfupdate and update).
Signed-off-by: Marti Bolivar <marti@foundries.io>
To align the way `west selfupdate` and `west update` works then
`west selfupdate` has now been adjusted to support --rebase and
--keep-descendants to align functionality with `west update`.
This should make it easier to describe and understand the overall
update functionality in west.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
west list --format={abspath} is intended to use with Zephyr's CMake
build system. In order for CMake not escape path, such as C:\<path>
PurePath.as_posix() is used to ensure forward slashes when printing
abspath in a new posixpath format key.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Signed-off-by: Marti Bolivar <marti@foundries.io>
This allows users to operate on the manifest. The only thing they can
do now is 'freeze' it by printing everything with SHAs as revisions.
This required a surprising amount of shenanigans to get the
representation to look halfway decent and reflect our desired key
ordering when printing maps. I had to incorporate some MIT-licensed
code from PyYAML itself to make it work.
Signed-off-by: Marti Bolivar <marti@foundries.io>
This fixes an issue where west update could fail to checkout a SHA as
revision if that SHA was located on a branch that was not being
fetched.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
Fixes: #186
Instead of cloning manifest repo into temp directory, which can be a
disk different from final destination, then the manifest repo is now
cloned into .west, and from there, moved to its final location.
Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
This page just got moved so the link is invalid.
I've now been hurt, so I won't trust again by updating it :). Instead,
just remove it entirely.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Older versions of git don't support this. Since
subprocess.check_call() supports a cwd kwarg which provides equivalent
functionality, use that instead.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Fall back on ZEPHYR_BASE for backwards compatibility. While we are
here, sync up the two versions of this function's way to get the final
"start" value, and improve the error message when we fail to find the
installation.
Fixes: #175
Signed-off-by: Marti Bolivar <marti@foundries.io>
On Windows, sys.argv[0] is the path to an executable (.exe) instead of
a Python script. Execute that file directly instead of relying on
Python to do so.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Rename BadExternalCommand to ExtensionCommandError and make it a
subclass of CommandError so that it fits naturally in the hierarchy
and provides a returncode.
Add a hint attribute to it so that we can print further diagnostic
information to the user when things go wrong.
While we are here, use traceback.print_exc() in the error handlers at
main level to make it more clear that the verbosity is not altering
the control flow of the program, just what is being printed. Also use
the returncode attribute in a CalledProcessError since that is
available.
Print the entire command invocation that caused the problem with -v
added instead of making the user guess what to do.
Signed-off-by: Marti Bolivar <marti@foundries.io>
The restriction that extension commands have names which are valid
Python identifiers is arbitrary and unnecessarily restrictive.
For example, it should be possible to have a command with a dash (-)
in its name to separate words, like "submit-pr". This is currently not
possible.
Resolve that by generating module names from an infinite iterator of
fresh per-file values instead of relying on the command name. We don't
actually need the name! Just the canonical path of the file which
defines it is important to avoid double imports.
Signed-off-by: Marti Bolivar <marti@foundries.io>
This is leftover work that we meant to do. It fixes up ugly warnings
in case the extension command is badly formed. The user can still get
a full stack trace with verbose operation enabled.
Signed-off-by: Marti Bolivar <marti@foundries.io>
The base west update is sufficient to get work done, but it has
inconveniences:
1. When working on a local topic branch in a project, I may want to
"west update" my local installation to sync with upstream, but not
leave behind my topic branches if they are still up to date
Make this possible by adding a -k / --keep descendants option,
which leaves the checked out branch unaltered (including any
uncommitted state in the working tree) if it's a descendant of the
new manifest-rev.
2. Similarly, having to run "git rebase" by hand when updating can be
annoying, especially if the rebases would have all succeeded and
there are multiple projects with topic branches open.
Avoid this when users explicitly opt in by adding a --rebase
option, which attempts to rebase any project branches onto the new
manifest-rev.
If both -k and -r are given and applicable to a project, -k wins.
Since the west update output is much longer now, refactor the code and
make some of the warning messages less verbose.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Rather than try to use the same argument parser for figuring out which
extension command to run and actually creating it and parsing its real
arguments, just recreate the top level parser and re-parse the
original argv when handling extension commands.
This makes things like 'west -v SOME_EXTENSION_COMMAND' work again.
Signed-off-by: Marti Bolivar <marti@foundries.io>
Marti Bolivar