Home
last modified time | relevance | path

Searched +full:doc +full:- +full:path (Results 1 – 25 of 100) sorted by relevance

1234

/Zephyr-latest/.github/workflows/
Ddoc-build.yml2 # SPDX-License-Identifier: Apache-2.0
8 - cron: '0 */3 * * *'
11 - v*
22 # and each sphinx-build process may use more than 2GiB of RAM.
26 doc-file-check:
27 name: Check for doc changes
28 runs-on: ubuntu-22.04
30 github.repository_owner == 'zephyrproject-rtos'
32 file_check: ${{ steps.check-doc-files.outputs.any_modified }}
34 - name: checkout
[all …]
/Zephyr-latest/scripts/west_commands/zspdx/
Ddatatypes.py3 # SPDX-License-Identifier: Apache-2.0
20 # standardized DocumentRef- (including that prefix) that the other
32 # configuration - DocumentConfig
47 # dict of absolute path on disk => File
53 # set of LicenseRef- custom licenses to be declared
54 # may or may not include "LicenseRef-" license prefix
71 # SPDX ID, including "SPDXRef-"
95 # absolute path of the "root" directory on disk, to be used as the
108 def __init__(self, cfg, doc): argument
111 # configuration - PackageConfig
[all …]
Dscanner.py3 # SPDX-License-Identifier: Apache-2.0
21 # when assembling a Package's data, should we auto-conclude the
25 # when assembling a Package's Files' data, should we auto-conclude
29 # number of lines to scan for SPDX-License-Identifier (0 = all)
43 p = line.partition("SPDX-License-Identifier:")
55 Scans the specified file for the first SPDX-License-Identifier:
59 - filePath: path to file to scan.
60 - numLines: number of lines to scan for an expression before
64 log.dbg(f" - getting licenses for {filePath}")
77 # invalid UTF-8 content
[all …]
Dwriter.py3 # SPDX-License-Identifier: Apache-2.0
14 r'^cpe:2\.3:[aho\*\-](:(((\?*|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&\'\(\)\+,\/:;<=>@\[\]\^'
15 … r"`\{\|}~]))+(\?*|\*?))|[\*\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[\*\-]))(:(((\?*"
16 …r'|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&\'\(\)\+,\/:;<=>@\[\]\^`\{\|}~]))+(\?*|\*?))|[\*\-])){4}…
21 # Replace "_" by "-" since it's not allowed in spdx ID
22 return name.replace("_", "-")
24 # Output tag-value SPDX 2.3 content for the given Relationship object.
31 # Output tag-value SPDX 2.3 content for the given File object.
68 # Output tag-value SPDX 2.3 content for the given Package object.
132 # Output tag-value SPDX 2.3 content for a custom license.
[all …]
Dwalker.py1 # Copyright (c) 2020-2021 The Linux Foundation
3 # SPDX-License-Identifier: Apache-2.0
43 # configuration - WalkerConfig
53 # dict of absolute file path => the Document that owns that file
65 # parsed CMake cache dict, once we have the build path
68 # C compiler path from parsed CMake cache
71 # SDK install path from parsed CMake cache
81 …|http(s)?:\/\/)(?P<base_url>[\w\.@]+)(\/|:))(?P<namespace>[\w,\-,\_]+)\/(?P<package>[\w,\-,\_]+)(.…
92 def _add_describe_relationship(self, doc, cfgpackage): argument
96 rd.ownerDocument = doc
[all …]
/Zephyr-latest/doc/contribute/documentation/
Dgeneration.rst11 .. _documentation-overview:
18 using Sphinx to create a formatted stand-alone website. Developers can
32 are found in the ``/doc`` directory, but others are stored within the
36 * Doxygen-generated material used to create all API-specific documents
39 * Script-generated material for kernel configuration options based on Kconfig
51 rtd [shape="rectangle" label="read-the-docs\ntheme"]
56 images -> sphinx
57 rst -> sphinx
58 conf -> sphinx
59 header -> doxygen
[all …]
Dguidelines.rst24 .. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html
26 .. _Sphinx Inline Markup: http://sphinx-doc.org/markup/inline.html#inline-markup
30 Sphinx-defined directives and roles used to create the documentation
42 the first non-white space in the preceding line. For example::
50 .. code-block::
66 * Third section heading level (h4) use ``-``
84 For bullet lists, place an asterisk (``*``) or hyphen (``-``) at
113 #. This is a second-level list under the first item (also
143 Multi-column lists
148 a special ``.. rst-class:: rst-columns`` directive. The directive will
[all …]
/Zephyr-latest/doc/
Dconf.py2 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
8 from pathlib import Path
10 ZEPHYR_BASE = Path(__file__).resolve().parents[1]
11 ZEPHYR_BUILD = Path(os.environ.get("OUTPUT_DIR")).resolve()
13 # Add the '_extensions' directory to sys.path, to enable finding Sphinx
15 sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions"))
17 # Add the '_scripts' directory to sys.path, to enable finding utility
19 sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_scripts"))
23 sys.path.insert(0, str(ZEPHYR_BASE / "scripts" / "west_commands"))
25 # Add the directory which contains the pytest-twister-pytest
[all …]
/Zephyr-latest/scripts/ci/
Dcheck_compliance.py5 # SPDX-License-Identifier: Apache-2.0
14 from pathlib import Path
34 sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
57 f"{cp.stdout.decode('utf-8')}\n"
59 f"{cp.stderr.decode('utf-8')}\n")
61 return cp.stdout.decode("utf-8").rstrip()
70 return git('rev-list',
71 f'--max-count={-1 if "." in refspec else 1}', refspec).split()
74 filter_arg = (f'--diff-filter={filter}',) if filter else ()
75 paths_arg = ('--', *paths) if paths else ()
[all …]
/Zephyr-latest/boards/quicklogic/qomu/doc/
Dindex.rst6 The Qomu board is a platform with an on-board QuickLogic EOS S3 Sensor Processing Platform.
11 - QuickLogic EOS S3 MCU Platform
12 - 16 Mbit of on-board flash memory
13 - Touchpads (4)
14 - RGB LED
15 - Powered from USB
33 .. zephyr-app-commands::
34 :zephyr-app: samples/boards/quicklogic/qomu
40 #. While the blue LED is blinking (for 5 seconds), touch the touch-pads with your finger.
44 .. code-block:: console
[all …]
/Zephyr-latest/boards/quicklogic/quick_feather/doc/
Dindex.rst6 The QuickFeather development board is a platform with an on-board QuickLogic
12 - QuickLogic EOS S3 MCU Platform
13 - mCube MC3635 accelerometer
14 - Infineon DPS310 pressure sensor
15 - Infineon IM69D130 MEMS microphone
16 - 16 Mbit of on-board flash memory
17 - User button
18 - RGB LED
19 - Integrated battery charger
29 +-----------+------------+-------------------------------------+
[all …]
/Zephyr-latest/doc/develop/sca/
Declair.rst9 particular emphasis on the MISRA and BARR-C coding standards, to the
22 To run ECLAIR, :ref:`west build <west-building>` should be
23 called with a ``-DZEPHYR_SCA_VARIANT=eclair`` parameter.
25 .. code-block:: shell
27 west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair
43 .. code-block:: shell
45 …west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_OPTIONS_…
51 file, that can be achived by giving the argument ``-DOption=ON|OFF``.
55 .. code-block:: shell
57 …west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_REPORTS_…
[all …]
/Zephyr-latest/samples/boards/quicklogic/qomu/
DREADME.rst6 This sample demonstrates how to load bitstream on EOS-S3 FPGA and use the
12 * `QuickLogic Qomu board <https://www.quicklogic.com/products/eos-s3/quickfeather-development-kit/>…
17 .. zephyr-app-commands::
18 :zephyr-app: samples/boards/quicklogic/qomu
19 :host-os: unix
27 …mple into Qomu you can use `TinyFPGA-Programmer-Application <https://github.com/QuickLogic-Corp/Ti…
29 .. code-block:: console
31 …python3 /PATH/TO/BASE/DIR/TinyFPGA-Programmer-Application/tinyfpga-programmer-gui.py --mode m4 --m…
33 …User Guide <https://github.com/QuickLogic-Corp/qomu-dev-board/blob/662f8841bdc1ed35c1539ac38118215…
40 .. code-block:: console
/Zephyr-latest/scripts/west_commands/
Dblobs.py3 # SPDX-License-Identifier: Apache-2.0
7 from pathlib import Path
16 sys.path.append(os.fspath(Path(__file__).parent.parent))
21 DEFAULT_LIST_FMT = '{module} {status} {path} {type} {abspath}'
26 # Keep this in sync with the string in west-commands.yml.
39 --------------
50 - module: name of the module that contains this blob
51 - abspath: blob absolute path
52 - status: short status (A: present, M: hash failure, D: not present)
53 - path: blob local path from <module>/zephyr/blobs/
[all …]
Dspdx.py3 # SPDX-License-Identifier: Apache-2.0
13 This command creates an SPDX 2.2 tag-value bill of materials
17 BUILDDIR/.cmake/api/v1/query/codemodel-v2 in order to enable
18 the CMake file-based API, which the SPDX command relies upon.
19 This can be done by calling `west spdx --init` prior to
35 # doc/guides/west/zephyr-cmds.rst up to date.
36 parser.add_argument('-i', '--init', action="store_true",
37 help="initialize CMake file-based API")
38 parser.add_argument('-d', '--build-dir',
40 parser.add_argument('-n', '--namespace-prefix',
[all …]
/Zephyr-latest/doc/_extensions/zephyr/
Dapi_overview.py2 # SPDX-License-Identifier: Apache-2.0
4 from pathlib import Path
18 version it is present - all information extracted from Doxygen XML output.
20 It is exclusively used by the doc/develop/api/overview.rst page.
45 github_uri = "https://github.com/zephyrproject-rtos/zephyr/releases/tag/"
67 url_base = Path(app.config.api_overview_doxygen_base_url)
103 root = doxmlparser.index.parse(Path(dir_name) / "index.xml", True)
106 file_name = Path(dir_name) / f"{compound.get_refid()}.xml"
140 def sync_contents(app: Sphinx) -> None:
142 doxygen_out_dir = Path(app.config.doxyrunner_outdir)
[all …]
Dgh_utils.py8 SPDX-License-Identifier: Apache-2.0
29 - ``gh_link_version``: GitHub version to use in the URL (e.g. "main")
30 - ``gh_link_base_url``: Base URL used as a prefix for generated URLs.
31 - ``gh_link_prefixes``: Mapping of pages (regex) <> GitHub prefix.
32 - ``gh_link_exclude``: List of pages (regex) that will not report a URL. Useful
33 for, e.g., auto-generated pages not in Git.
42 from pathlib import Path
50 sys.path.insert(0, str(Path(__file__).parents[3] / "scripts"))
54 ZEPHYR_BASE : Final[str] = Path(__file__).parents[3]
61 def get_page_prefix(app: Sphinx, pagename: str) -> str:
[all …]
/Zephyr-latest/doc/build/kconfig/
Dpreprocessor-functions.rst1 .. _kconfig-functions:
13 <https://www.kernel.org/doc/html/latest/kbuild/kconfig-macro-language.html>`__.
21 Devicetree-related Functions
28 .. code-block:: none
48 $(dt_node_array_prop_hex,<node path>,<prop>,<index>[,<unit>])
49 $(dt_node_array_prop_int,<node path>,<prop>,<index>[,<unit>])
50 $(dt_node_bool_prop,<node path>,<prop>)
51 $(dt_node_has_compat,<node path>,<compatible string>)
52 $(dt_node_has_prop,<node path>,<prop>)
53 $(dt_node_int_prop_hex,<node path>,<prop>[,<unit>])
[all …]
/Zephyr-latest/doc/_scripts/
Dgen_boards_catalog.py2 # SPDX-License-Identifier: Apache-2.0
6 from pathlib import Path
14 ZEPHYR_BASE = Path(__file__).parents[2]
43 "doc/index.{ext}",
55 vnd_lookup = VndLookup(ZEPHYR_BASE / "dts/bindings/vendor-prefixes.txt", [])
67 module_settings[key].append(Path(module.project) / root)
Dgen_devicetree_rest.py2 # SPDX-License-Identifier: Apache-2.0
19 from pathlib import Path
24 ZEPHYR_BASE = Path(__file__).parents[2]
26 GENERIC_OR_VENDOR_INDEPENDENT = 'Generic or vendor-independent'
29 ZEPHYR_BASE = Path(__file__).parents[2]
31 # Base properties that have documentation in 'dt-important-props'.
59 # Load the vendor-prefixes.txt file. Return a dict mapping 'vnd'
65 # vnd A stand-in for a real vendor
67 # Gets split into a key 'vnd' and a value 'A stand-in for a real
77 logger.info('found %d vendor prefixes in %s', len(vnd2vendor) - 1,
[all …]
/Zephyr-latest/
DMAINTAINERS.yml39 # If a path or glob pattern ends in a '/', it matches all files within
45 # files-regex:
48 # the path, but can be anchored with ^ and $ as usual.
56 # files-exclude:
59 # files-regex-exclude:
60 # Like 'files-regex', but any matching files will be excluded from the
63 # description: >-
64 # Plain-English description. Describe what the system is about, from an
68 # All areas must have a 'files' and/or 'files-regex' key. The other keys are
72 # this would be sub-areas which add extra fields (for ex. more `collaborators`
[all …]
/Zephyr-latest/subsys/bluetooth/host/
Dsettings.c4 * SPDX-License-Identifier: Apache-2.0
26 void bt_settings_encode_key(char *path, size_t path_size, const char *subsys, in bt_settings_encode_key() argument
30 snprintk(path, path_size, in bt_settings_encode_key()
32 addr->a.val[5], addr->a.val[4], addr->a.val[3], in bt_settings_encode_key()
33 addr->a.val[2], addr->a.val[1], addr->a.val[0], in bt_settings_encode_key()
34 addr->type, key); in bt_settings_encode_key()
36 snprintk(path, path_size, in bt_settings_encode_key()
38 addr->a.val[5], addr->a.val[4], addr->a.val[3], in bt_settings_encode_key()
39 addr->a.val[2], addr->a.val[1], addr->a.val[0], in bt_settings_encode_key()
40 addr->type); in bt_settings_encode_key()
[all …]
/Zephyr-latest/tests/bsim/bluetooth/ll/edtt/
DREADME.txt8 and in its `doc/` folder.
50 The shortest path is to use the provided scripts.
54 cd ${ZEPHYR_BASE} && source zephyr-env.sh
/Zephyr-latest/cmake/modules/
DFindTargetTools.cmake1 # SPDX-License-Identifier: Apache-2.0
7 # +---------------------------------------------------------------+
9 # +---------------------------------------------------------------+
10 # | Target C-compiler | Yes | |
13 # +---------------------------------------------------------------+
18 # Path to target C compiler.
19 # Set to 'CMAKE_C_COMPILER-NOTFOUND' if no C compiler was found.
37 # https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/CrossCompiling:
42 # like Linux.cmake or Windows-gcc.cmake. If your target is an embedded
49 # https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/CrossCompiling:
[all …]
/Zephyr-latest/boards/sipeed/longan_nano/doc/
Dindex.rst7 an GigaDevice GD32VF103 SoC that based on N200 RISC-V IP core by Nuclei system technology.
10 - `Sipeed Longan website <https://longan.sipeed.com/en/>`_
11 - `GD32VF103 datasheet <https://www.gigadevice.com/datasheet/gd32vf103xxxx-datasheet/>`_
12 - `GD32VF103 user manual <https://www.gd32mcu.com/data/documents/userManual/GD32VF103_User_Manual_R…
13 - `Nuclei website <https://www.nucleisys.com/download.php>`_
14 - `Nuclei Bumblebee core documents <https://github.com/nucleisys/Bumblebee_Core_Doc>`_
15 - `Nuclei ISA Spec <https://doc.nucleisys.com/nuclei_spec/>`_
20 - 4 x universal 16-bit timer
21 - 2 x basic 16-bit timer
22 - 1 x advanced 16-bit timer
[all …]

1234