zephyr/doc
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
..
_doxygen doc: kernel: define additional doxygen groups 2024-09-17 05:24:09 -04:00
_extensions/zephyr doc: gh_utils: ignore added-but-not-committed files 2025-01-16 14:52:35 +01:00
_scripts doc: _scripts: gen_devicetree_rest: add individual files 2025-01-07 00:26:08 +01:00
_static doc: css: boards: fix font size for board name 2024-11-27 10:37:54 -05:00
_templates doc: enable three-way dark-mode switch 2024-10-16 16:33:24 +01:00
build cmake: Added "-" support to EXTRAVERSION 2025-01-21 15:13:36 +01:00
connectivity doc: net: http-server: Add information about static fs resources 2025-01-14 15:39:50 +01:00
contribute doc: contribute: split style guidelines into own document 2025-01-22 18:33:06 +01:00
develop doc: the west workspace topdir is not a git repository 2025-01-23 19:22:13 +01:00
hardware drivers: firmware: scmi: add power domain protocol 2025-01-15 19:03:00 +01:00
images
introduction doc: clarify what a subsystem is 2024-05-14 10:55:55 +02:00
kernel kernel/pipe: implement direct-to-pending-readers data copy 2025-01-21 19:44:57 +01:00
project doc: review: switch labels to a definition list 2025-01-22 18:33:06 +01:00
releases doc: release: Add notes for Bluetooth ECDH changes 2025-01-23 10:14:46 +01:00
safety doc: coding guidelines: move safety related language to saftey section 2025-01-18 02:33:02 +01:00
security doc: security: Disclose CVE-2024-8798 2024-12-16 04:46:33 +01:00
services doc: Update the File Systems samples link syntax 2025-01-16 22:56:44 +01:00
templates doc: boards: extensions: introduce zephyr:board role and directive 2024-10-22 14:11:27 +02:00
404.rst doc: Suggest filing GitHub issue for broken links 2022-04-28 10:26:03 +02:00
CMakeLists.txt doc: get output folder from environment 2024-09-25 13:49:34 -05:00
conf.py doc: update copyright notice in the documentation 2025-01-10 14:56:01 +01:00
glossary.rst doc: sphinx-lint: fix bad usage of "default role" 2024-09-13 11:42:51 -05:00
index-tex.rst doc: pdf: Add Glossary of Terms to PDF output 2023-11-13 12:17:51 -05:00
index.rst doc: reorder tiles 2024-12-25 12:41:09 +01:00
kconfig.rst doc: use new kconfig extension 2022-03-02 09:28:37 +01:00
LICENSING.rst doc: licensing: clarify the impact of the various files 2025-01-08 17:01:24 +01:00
Makefile doc: add make html-live and html-live-fast 2024-08-26 17:05:39 +02:00
requirements.txt doc: requirements: avoid using pygments v2.19.0 2025-01-05 22:09:44 +01:00
substitutions.txt
zephyr.doxyfile.in net: sockets: Remove deperecated CONFIG_NET_SOCKETS_POSIX_NAMES 2024-12-04 12:09:51 +01:00