Lines Matching +full:repo +full:- +full:path
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
29 the project's `GitHub repo`_) to strike a balance between open
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.
156 - If you are altering an existing commit created by someone else, you must add
157 your Signed-off-by: line without removing the existing one.
159 - If you forget to add the Signed-off-by: line, you can add it to your previous
160 commit by running ``git commit --amend -s``.
162 - If you've pushed your changes to GitHub already you'll need to force push
163 your branch after this with ``git push -f``.
169 for the Project to use. Developers are permitted to cherry-pick patches that
174 * the cherry-picked commits or portions of a commit shall preserve the original
175 sign-off messages and the author identity.
226 The top-level file for the CMake build system, containing a lot of the
230 The top-level Kconfig file, which refers to the file :file:`Kconfig.zephyr`
231 also found in the top-level directory.
238 the west command-line tool.
240 The Zephyr source tree also contains the following top-level
245 Architecture-specific kernel and system-on-chip (SoC) code.
250 * architecture-specific kernel source files
251 * architecture-specific kernel include files for private APIs
267 :ref:`devicetree <dt-guide>` source files used to describe non-discoverable
268 board-specific hardware details.
274 Architecture-independent kernel code.
280 Miscellaneous code that doesn't belong to any of the other top-level
311 .. _Zephyr Project Issues: https://github.com/zephyrproject-rtos/zephyr/issues
313 .. _open pull requests: https://github.com/zephyrproject-rtos/zephyr/pulls
349 .. code-block:: console
351 git config --global user.name "Zephyr Developer"
352 git config --global user.email "z.developer@example.com"
364 .. _commit-guidelines:
373 .. code-block:: none
377 [Commit message body (must be non-empty)]
379 Signed-off-by: [Your Full Name] <[your.email@address]>
387 -------
391 .. code-block:: none
398 buffer. Fix it by checking the flag and adding an error path.
400 Signed-off-by: Zephyr Developer <z.developer@example.com>
403 ---------------------------
421 * ``net: ethernet:`` for Ethernet-related networking changes
437 -------------------
452 * **how** you know it works -- for example, which tests you ran.
459 `changelog <https://github.com/zephyrproject-rtos/zephyr/commits/main>`__.
462 Signed-off-by: ...
463 ------------------
468 already. Create your commit with ``git commit -s`` to add the
469 Signed-off-by: line automatically using this information.
472 Signed-off-by: line that looks like this:
474 .. code-block:: none
476 Signed-off-by: [Your Full Name] <[your.email@address]>
481 .. code-block:: none
483 Signed-off-by: Zephyr Developer <z.developer@example.com>
492 See the :ref:`contributor-expectations` for a more complete discussion of
496 ------------
499 …https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolink…
506 .. code-block:: none
513 .. code-block:: none
521 .. code-block:: none
523 Link: https://github.com/zephyrproject-rtos/zephyr/issues/<issue number>
531 https://kernel.org/doc/html/latest/process/coding-style.html
539 ``switch`` body, even for single-line code blocks. Use the ``--ignore BRACES``
542 * Use C89-style single line comments, ``/* */``. The C99-style single line
546 * Avoid using non-ASCII symbols in code, unless it significantly improves
552 The Linux kernel GPL-licensed tool ``checkpatch`` is used to check
559 code, make the file *$ZEPHYR_BASE/.git/hooks/pre-commit* executable and edit
562 .. code-block:: bash
565 set -e exec
566 exec git diff --cached | ${ZEPHYR_BASE}/scripts/checkpatch.pl -
569 before pushing on zephyr repo. To do this, make the file
570 *$ZEPHYR_BASE/.git/hooks/pre-push* executable and edit it to contain:
572 .. code-block:: bash
585 exec ${ZEPHYR_BASE}/scripts/series-push-hook.sh $args
591 issues, you can add option --no-verify to the git push command.
595 clang-format
596 ------------
598 The `clang-format tool <https://clang.llvm.org/docs/ClangFormat.html>`_ can
600 `Coding Style`_ standards together with the ``.clang-format`` configuration file
601 provided in the repository. ``clang-format`` is well integrated into most
604 .. code-block:: bash
606 clang-format -i my_source_file.c
608 ``clang-format`` is part of LLVM, which can be downloaded from the project
609 `releases page <https://github.com/llvm/llvm-project/releases>`_. Note that if
610 you are a Linux user, ``clang-format`` will likely be available as a package in
649 non-green) build.
659 -------------------
669 .. code-block:: bash
671 ./scripts/ci/check_compliance.py -c upstream/main..
674 -------
686 .. code-block:: bash
688 west twister -p native_sim -s tests/drivers/build_all/sensor/sensors.generic_test
715 Static analysis of the Zephyr codebase is conducted on a bi-weekly basis. GitHub
760 https://github.com/zephyrproject-rtos/zephyr#fork-destination-box
764 right corner of the Zephyr project repo page in GitHub.)
772 <https://github.com/zephyrproject-rtos/zephyr>`_ from ``origin`` to
783 git remote -v
789 upstream https://github.com/zephyrproject-rtos/zephyr (fetch)
790 upstream https://github.com/zephyrproject-rtos/zephyr (push)
796 git checkout -b fix_comment_typo
801 git checkout -b fix_out_of_date_patch origin/net
809 git add [file(s) that changed, add -p if you want to be more specific]
817 git diff --cached
819 #. Commit your changes to your local repo::
821 git commit -s
823 The ``-s`` option automatically adds your ``Signed-off-by:`` to your commit
825 agreement with the :ref:`DCO`. See the :ref:`commit-guidelines` section for
833 #. In your web browser, go to your forked repo and click on the
842 MAINTAINERS file in the repo). If you are a project member, you can
847 on your pull request at https://github.com/zephyrproject-rtos/zephyr/pulls.
850 a ``This branch is out-of-date with the base branch`` message and a
861 git checkout -b fix_another_issue
866 commit(s) to fix review issues. In your development repo::
868 git rebase -i <offending-commit-id>^
879 git rebase --continue
883 git push --force origin fix_comment_typo
891 git fetch --all
892 git rebase --ignore-whitespace upstream/main
894 The ``--ignore-whitespace`` option stops ``git apply`` (called by rebase)
897 git push --force origin fix_comment_typo
903 one - GitHub complains it can't find older commits. You're also not
922 .. _git-rebase:
923 https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---keep-base
925 #. When pushing follow-up changes, use the ``--keep-base`` option of
926 `git-rebase`_
941 #. Revisit PR after 1-2 hours to see the status of all CI checks, make sure all
945 sure you click the "Re-request review" button on the GitHub UI to notify
984 <external-contributions>`, the commit message shall contain details regarding
985 the original project, the location of the project, the SHA-id of the origin
991 License: BSD 3-Clause
992 URL: http://www.contiki-os.org/
999 License: BSD 3-Clause
1011 .. _treewide-changes:
1027 do so for a wide class of external Zephyr-based source code.
1041 - The zephyr repository must apply the 'treewide' GitHub label to any issues or
1044 - The person proposing a treewide change must create an `RFC issue
1045 …<https://github.com/zephyrproject-rtos/zephyr/issues/new?assignees=&labels=RFC&template=003_rfc-pr…
1049 - The project's `Architecture Working Group (WG)
1050 <https://github.com/zephyrproject-rtos/zephyr/wiki/Architecture-Working-Group>`_
1056 - The Architecture WG must specify the procedure for merging any PRs associated
1060 - The person proposing a treewide change must email
1069 - the deprecation of version 1 of the :ref:`Logging API <logging_api>` in favor
1071 <https://github.com/zephyrproject-rtos/zephyr/commit/262cc55609b73ea61b5f999c6c6daaba20bc5240>`_)
1072 - the removal of support for a legacy :ref:`dt-bindings` syntax
1074 <https://github.com/zephyrproject-rtos/zephyr/commit/6bf761fc0a2811b037abec0c963d60b00c452acb>`_)
1089 extend the support for an external device by providing a specialized path for
1090 that SoC family. However, the driver must still provide a regular path (via