zephyr/doc/develop/west
Martí Bolívar 7d40091fbf doc: the west workspace topdir is not a git repository
It's a design decision that the west workspace "topdir"
(that is, the top level directory containing the .west directory), is
not itself a git repository. This exists to give us some breathing
room to make changes to the workspace which would otherwise
potentially cause breakage if the entire workspace is in .git.

While this has always been the case, I'm documenting this now because
I reviewed a PR today that flipped my bit from "this is a question to
answer on a case by case basis" to "this is a frequently enough asked
question that I want to be able to link people to the answer":

https://github.com/zephyrproject-rtos/zephyr/pull/84305

We can debate the wisdom of this design decision (and, informally,
I've always tried to avoid breaking these setups), but IMO it's too
late to try to change this in west. Make it explicit in the docs that
you're on your own if you try this.

Signed-off-by: Martí Bolívar <marti.bolivar@oss.qualcomm.com>
2025-01-23 19:22:13 +01:00
..
alias.rst doc: develop: west: Add alias documentation 2024-10-30 14:30:31 -05:00
basics.rst tools: net-tools: place net-tools inside tools 2024-09-05 12:34:09 -05:00
build-flash-debug.rst doc: develop: Add external runners for modules information 2025-01-08 17:02:06 +01:00
built-in.rst doc: west: add docs for west grep 2023-10-21 13:14:57 +02:00
config.rst doc: develop: west: Add alias documentation 2024-10-30 14:30:31 -05:00
extensions.rst doc: develop: west: Remove deprecated west.log 2024-11-18 13:18:42 -05:00
index.rst doc: develop: west: Add alias documentation 2024-10-30 14:30:31 -05:00
install.rst Documentation: Update shell completion doc 2024-04-02 15:07:19 +02:00
manifest.rst doc: Fix occurrences of repeated words 2023-11-15 17:34:39 -05:00
moving-to-west.rst
release-notes.rst doc: Fix occurrences of repeated words 2023-11-15 17:34:39 -05:00
sign.rst doc: sign: minor rimage update following imgtool removal 2024-10-22 18:28:29 -04:00
troubleshooting.rst doc: west: troubleshooting: fix path 2023-06-04 16:52:20 -07:00
west-apis.rst doc: sphinx-lint: fix unbalanced-inline-literals-delimiters 2024-09-11 07:39:30 -04:00
west-mr-model.png
west-not-found.rst
why.rst
without-west.rst
workspaces.rst doc: the west workspace topdir is not a git repository 2025-01-23 19:22:13 +01:00
zephyr-cmds.rst west: bindesc: Added get_offset command 2024-10-11 13:20:49 -04:00