adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: the west workspace topdir is not a git repository

Browse source 
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>
This commit is contained in:
Martí Bolívar 2025-01-21 09:52:46 -08:00 committed by Benjamin Cabé
parent e07896fc9d
commit 7d40091fbf
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/develop/west/workspaces.rst
View file

@ -321,3 +321,25 @@ v2.5.0 and its modules, then add the ``app1`` and ``app2`` projects:
You can also do this "by hand" by copy/pasting :file:`zephyr/west.yml` You can also do this "by hand" by copy/pasting :file:`zephyr/west.yml`
as shown :ref:`above <west-t2>` for the T2 topology, with the same caveats. as shown :ref:`above <west-t2>` for the T2 topology, with the same caveats.
.. _workspace-as-git-repo:
Not supported: workspace topdir as .git repository
**************************************************
Some users have asked for support making the workspace :ref:`topdir
<west-workspace>` a git repository, like this example:
.. code-block:: none
my-workspace/ # workspace topdir
├── .git/ # puts the entire workspace in a git repository
├── .west/ # marks the location of the topdir
└── [ ... other projects ...]
This is **not** an officially supported topology. As a design decision, west
assumes that the workspace topdir itself is not a git repository.
You may be able to make something like this "work" for yourself and your own
goals. However, future versions of west might contain changes which can "break"
your setup.