Lines Matching +full:build +full:- +full:docs
1 .. _docs-pw-style:
11 ``pw presubmit --install``
15 .. grid-item-card:: :octicon:`diff-added` C++ style
16 :link: docs-pw-style-cpp
17 :link-type: ref
18 :class-item: sales-pitch-cta-primary
24 .. grid-item-card:: :octicon:`pencil` Commit messages
25 :link: docs-pw-style-commit-message
26 :link-type: ref
27 :class-item: sales-pitch-cta-secondary
33 .. grid-item-card:: :octicon:`code-square` Protobuf
34 :link: docs-pw-style-protobuf
35 :link-type: ref
36 :class-item: sales-pitch-cta-secondary
40 .. grid-item-card:: :octicon:`terminal` CLI style
41 :link: docs-pw-style-cli
42 :link-type: ref
43 :class-item: sales-pitch-cta-secondary
48 --------------------------
50 --------------------------
51 See the :ref:`documentation contributors homepage <docs-contrib-docs>`.
53 .. todo-check: disable
55 .. _docs-pw-todo-style:
57 ----------
59 ----------
62 .. todo-check: disable
64 .. code-block:: py
66 # TODO: https://pwbug.dev/123456789 - Some explanation of the problem at
69 .. todo-check: enable
76 In Markdown docs like
77 `Rustdoc <https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html>`_
80 .. todo-check: disable
82 .. code-block:: rs
84 //! TODO: <pwbug.dev/123456789> - Explanation.
86 .. todo-check: enable
97 .. todo-check: disable
99 .. code-block:: py
101 # TODO: https://pwbug.dev/1234 - Explanation.
102 # TODO: b/1234 - Explanation.
103 # TODO: username@ - Explanation.
104 # TODO: username@example.com - Explanation.
108 .. todo-check: enable
110 .. todo-check: enable
112 -----------------
114 -----------------
121 .. code-block:: none
129 // https://www.apache.org/licenses/LICENSE-2.0
139 .. code-block:: none
147 # https://www.apache.org/licenses/LICENSE-2.0
155 ---------------
156 Build files: GN
157 ---------------
158 Each Pigweed source module requires a GN build file named BUILD.gn. This
159 encapsulates the build targets and specifies their sources and dependencies.
160 GN build files use a format similar to `Bazel's BUILD files
161 <https://docs.bazel.build/versions/main/build-ref.html>`_
163 <https://docs.bazel.build/versions/main/skylark/build-style.html>`_).
165 C/C++ build targets include a list of fields. The primary fields are:
167 * ``<public>`` -- public header files
168 * ``<sources>`` -- source files and private header files
169 * ``<public_configs>`` -- public build configuration
170 * ``<configs>`` -- private build configuration
171 * ``<public_deps>`` -- public dependencies
172 * ``<deps>`` -- private dependencies
176 .. code-block:: cpp
178 # Here is a brief example of a GN build file.
208 pw_doc_group("docs") {
209 sources = [ "docs.rst" ]
212 ------------------
213 Build files: Bazel
214 ------------------
215 Build files for the Bazel build system must be named ``BUILD.bazel``. Bazel can
216 interpret files named just ``BUILD``, but Pigweed uses ``BUILD.bazel`` to avoid
217 ambiguity with other build systems or tooling.
220 <https://docs.bazel.build/versions/main/skylark/build-style.html>`_.
222 ------------------
223 Build files: Soong
224 ------------------
225 Build files (blueprints) for the Soong build system must be named
227 :ref:`module-pw_build_android`.
229 .. _owners-style:
231 --------------------
233 --------------------
235 `code-owners <https://android-review.googlesource.com/plugins/code-owners/Documentation/backend-fin…
236 plug-in enabled Pigweed can help you enforce consistent styling on those files
250 * "per-file:" lines