zephyr/doc/develop
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
..
api docs: api_lifecycle: Use a better release as example for deprecation 2024-08-15 12:40:16 +02:00
application doc: samples: Adopt code-sample-category across tree 2024-09-23 12:00:00 +02:00
debug doc: sphinx-lint: fix bad usage of "default role" 2024-09-13 11:42:51 -05:00
flash_debug west: runners: bossac: Honor --erase flag 2024-12-22 18:20:30 +00:00
getting_started doc: gsg: warn against using Python 3.13 on Windows 2024-11-28 12:53:42 +01:00
languages docs: add information about main(int, char **) 2024-09-05 12:30:39 -05:00
manifest doc: develop: manifests: external: add CANnectivity USB to CAN adapter 2024-09-18 15:30:16 +02:00
optimizations doc: samples: use :zephyr-app: for in-tree samples 2024-09-05 17:18:05 -04:00
sca sca: added support for Polyspace tool 2025-01-07 14:13:13 +01:00
test doc: develop: toolchains: Remove 'xtools' documentation 2025-01-17 10:50:07 +01:00
toolchains doc: develop: toolchains: Remove 'xtools' documentation 2025-01-17 10:50:07 +01:00
tools doc: develop: tools: CLion: add update note 2024-12-16 20:50:31 +01:00
west doc: the west workspace topdir is not a git repository 2025-01-23 19:22:13 +01:00
beyond-GSG.rst doc: samples: Adopt code-sample-category across tree 2024-09-23 12:00:00 +02:00
env_vars.rst doc: fix typos 2023-11-08 10:09:44 +01:00
index.rst doc: extract the documentation about debugging to another file 2023-09-06 17:54:53 +02:00
modules.rst doc: develop: Add external runners for modules information 2025-01-08 17:02:06 +01:00