Lines Matching +full:scan +full:- +full:limit
6 As an open-source project, we welcome and encourage the community to submit
24 https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE
26 .. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
38 https://www.zephyrproject.org/faqs/#1571346989065-9216c551-f523
41 https://www.whitesourcesoftware.com/whitesource-blog/top-10-apache-license-questions-answered/
64 See :ref:`external-contributions` for more information about
84 https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/
97 later in this document), the developer simply adds a ``Signed-off-by``
104 .. code-block:: none
129 sign-off) is maintained indefinitely and may be redistributed
133 DCO Sign-Off
136 The "sign-off" in the DCO is a "Signed-off-by:" line in each commit's log
137 message. The Signed-off-by: line must be in the following format::
139 Signed-off-by: Your Name <your.email@example.com>
143 - ``Your Name`` with your legal name (pseudonyms, hacker handles, and the
146 - ``your.email@example.com`` with the same email address you are using to
149 You can automatically add the Signed-off-by: line to your commit body using
150 ``git commit -s``. Use other commits in the zephyr git history as examples.
154 - If you are altering an existing commit created by someone else, you must add
155 your Signed-off-by: line without removing the existing one.
157 - If you forget to add the Signed-off-by: line, you can add it to your previous
158 commit by running ``git commit --amend -s``.
160 - If you've pushed your changes to GitHub already you'll need to force push
161 your branch after this with ``git push -f``.
167 for the Project to use. Developers are permitted to cherry-pick patches that
172 * the cherry-picked commits or portions of a commit shall preserve the original
173 sign-off messages and the author identity.
224 The top-level file for the CMake build system, containing a lot of the
228 The top-level Kconfig file, which refers to the file :file:`Kconfig.zephyr`
229 also found in the top-level directory.
236 the west command-line tool.
238 The Zephyr source tree also contains the following top-level
243 Architecture-specific kernel and system-on-chip (SoC) code.
248 * architecture-specific kernel source files
249 * architecture-specific kernel include files for private APIs
265 :ref:`devicetree <dt-guide>` source files used to describe non-discoverable
266 board-specific hardware details.
272 Architecture-independent kernel code.
278 Miscellaneous code that doesn't belong to any of the other top-level
309 .. _Zephyr Project Issues: https://github.com/zephyrproject-rtos/zephyr/issues
311 .. _open pull requests: https://github.com/zephyrproject-rtos/zephyr/pulls
340 .. _git-name-and-email:
353 .. code-block:: console
355 git config --global user.name "Zephyr Developer"
356 git config --global user.email "z.developer@example.com"
369 .. code-block:: console
374 after each commit, or use the ``--commits`` option to specify a commit range
389 limit tests to a single platform and an area in the kernel::
391 source zephyr-env.sh
392 west twister -p qemu_x86 -T tests/kernel/sched
395 ``--device-testing`` options. Please consult with the :ref:`Twister
401 .. code-block:: console
403 source zephyr-env.sh
404 west twister --integration
414 reasonable time, limit the scope to the areas and platforms you have modified.
420 clang-format
423 The `clang-format tool <https://clang.llvm.org/docs/ClangFormat.html>`_ can
425 `Coding Style`_ standards together with the ``.clang-format`` configuration file
426 provided in the repository. ``clang-format`` is well integrated into most
429 .. code-block:: bash
431 clang-format -i my_source_file.c
433 ``clang-format`` is part of LLVM, which can be downloaded from the project
434 `releases page <https://github.com/llvm/llvm-project/releases>`. Note that if
435 you are a Linux user, ``clang-format`` will likely be available as a package in
447 https://kernel.org/doc/html/latest/process/coding-style.html
455 ``switch`` body, even for single-line code blocks. Use the ``--ignore BRACES``
458 * Use C89-style single line comments, ``/* */``. The C99-style single line
466 The Linux kernel GPL-licensed tool ``checkpatch`` is used to check
473 code, make the file *$ZEPHYR_BASE/.git/hooks/pre-commit* executable and edit
476 .. code-block:: bash
479 set -e exec
480 exec git diff --cached | ${ZEPHYR_BASE}/scripts/checkpatch.pl -
484 *$ZEPHYR_BASE/.git/hooks/pre-push* executable and edit it to contain:
486 .. code-block:: bash
499 exec ${ZEPHYR_BASE}/scripts/series-push-hook.sh $args
505 issues, you can add option --no-verify to the git push command.
508 ci-tools repo.
514 Coverity Scan is a free service for static code analysis of Open Source
528 The results are available on the `Coverity Scan
529 <https://scan.coverity.com/projects/zephyr>`_ website. In order to access the
547 it after completing the steps above on scan service website. Any issues
548 closed without a fix or without ignoring the entry in the scan service will be
572 https://github.com/zephyrproject-rtos/zephyr#fork-destination-box
584 <https://github.com/zephyrproject-rtos/zephyr>`_ from ``origin`` to
595 git remote -v
601 upstream https://github.com/zephyrproject-rtos/zephyr (fetch)
602 upstream https://github.com/zephyrproject-rtos/zephyr (push)
608 git checkout -b fix_comment_typo
613 git checkout -b fix_out_of_date_patch origin/net
621 git add [file(s) that changed, add -p if you want to be more specific]
629 git diff --cached
633 git commit -s
635 The ``-s`` option automatically adds your ``Signed-off-by:`` to your commit
637 agreement with the :ref:`DCO`. See the :ref:`commit-guidelines` section for
659 on your pull request at https://github.com/zephyrproject-rtos/zephyr/pulls.
662 a ``This branch is out-of-date with the base branch`` message and a
673 git checkout -b fix_another_issue
680 git fetch --all
681 git rebase --ignore-whitespace upstream/main
683 The ``--ignore-whitespace`` option stops ``git apply`` (called by rebase)
686 git rebase -i <offending-commit-id>^
697 git rebase --continue
701 git push --force origin fix_comment_typo
710 one - GitHub complains it can't find older commits. You're also not
720 .. _commit-guidelines:
729 .. code-block:: none
733 [Commit message body (must be non-empty)]
735 Signed-off-by: [Your Full Name] <[your.email@address]>
747 .. code-block:: none
756 Signed-off-by: Zephyr Developer <z.developer@example.com>
777 * ``net: ethernet:`` for Ethernet-related networking changes
808 * **how** you know it works -- for example, which tests you ran.
815 `changelog <https://github.com/zephyrproject-rtos/zephyr/commits/main>`__.
819 .. code-block:: none
826 .. code-block:: none
830 Signed-off-by: ...
835 You should have set your :ref:`git-name-and-email`
836 already. Create your commit with ``git commit -s`` to add the
837 Signed-off-by: line automatically using this information.
840 Signed-off-by: line that looks like this:
842 .. code-block:: none
844 Signed-off-by: [Your Full Name] <[your.email@address]>
849 .. code-block:: none
851 Signed-off-by: Zephyr Developer <z.developer@example.com>
863 See the :ref:`contributor-expectations` for a more complete discussion of
901 <external-contributions>`, the commit message shall contain details regarding
902 the original project, the location of the project, the SHA-id of the origin
908 License: BSD 3-Clause
909 URL: http://www.contiki-os.org/
916 License: BSD 3-Clause
951 non-green) build.
960 .. _treewide-changes:
976 do so for a wide class of external Zephyr-based source code.
990 - The zephyr repository must apply the 'treewide' GitHub label to any issues or
993 - The person proposing a treewide change must create an `RFC issue
994 …<https://github.com/zephyrproject-rtos/zephyr/issues/new?assignees=&labels=RFC&template=003_rfc-pr…
998 - The project's `Architecture Working Group (WG)
999 <https://github.com/zephyrproject-rtos/zephyr/wiki/Architecture-Working-Group>`_
1005 - The Architecture WG must specify the procedure for merging any PRs associated
1009 - The person proposing a treewide change must email
1018 - the deprecation of version 1 of the :ref:`Logging API <logging_api>` in favor
1020 <https://github.com/zephyrproject-rtos/zephyr/commit/262cc55609b73ea61b5f999c6c6daaba20bc5240>`_)
1021 - the removal of support for a legacy :ref:`dt-bindings` syntax
1023 <https://github.com/zephyrproject-rtos/zephyr/commit/6bf761fc0a2811b037abec0c963d60b00c452acb>`_)