Lines Matching +full:check +full:- +full:bluetooth +full:- +full:files
6 As an open-source project, we welcome and encourage the community to submit
52 https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE
54 .. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
62 this, check out articles such as `Why choose Apache 2.0 licensing`_ and
66 https://www.zephyrproject.org/faqs/#1571346989065-9216c551-f523
69 https://www.whitesourcesoftware.com/whitesource-blog/top-10-apache-license-questions-answered/
92 See :ref:`external-contributions` for more information about
112 .. code-block:: C
117 https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/
130 later in this document), the developer simply adds a ``Signed-off-by``
137 .. code-block:: none
162 sign-off) is maintained indefinitely and may be redistributed
166 DCO Sign-Off
169 The "sign-off" in the DCO is a "Signed-off-by:" line in each commit's log
170 message. The Signed-off-by: line must be in the following format::
172 Signed-off-by: Your Name <your.email@example.com>
176 - ``Your Name`` with your legal name (pseudonyms, hacker handles, and the
179 - ``your.email@example.com`` with the same email address you are using to
182 You can automatically add the Signed-off-by: line to your commit body using
183 ``git commit -s``. Use other commits in the zephyr git history as examples.
189 - If you are altering an existing commit created by someone else, you must add
190 your Signed-off-by: line without removing the existing one.
208 At the top of the tree, several files are of importance:
211 The top-level file for the CMake build system, containing a lot of the
215 The top-level Kconfig file, which refers to the file :file:`Kconfig.zephyr`
216 also found in the top-level directory.
223 the west command-line tool.
225 The Zephyr source tree also contains the following top-level
230 Architecture-specific kernel and system-on-chip (SoC) code.
235 * architecture-specific kernel source files
236 * architecture-specific kernel include files for private APIs
239 SoC related code and configuration files.
242 Board related code and configuration files.
245 Zephyr technical documentation source files and tools used to
252 :ref:`devicetree <dt-guide>` source files used to describe non-discoverable
253 board-specific hardware details.
256 Include files for all public APIs, except those defined under :file:`lib`.
259 Architecture-independent kernel code.
265 Miscellaneous code that doesn't belong to any of the other top-level
272 Various programs and other files used to build and test Zephyr
282 * Networking code, including the Bluetooth stack and networking stacks
284 * Bluetooth host and controller
296 .. _Zephyr Project Issues: https://github.com/zephyrproject-rtos/zephyr/issues
298 .. _open pull requests: https://github.com/zephyrproject-rtos/zephyr/pulls
304 Before starting on a patch, first check in our issues `Zephyr Project Issues`_
334 .. code-block:: console
336 git config --global user.name "Zephyr Developer"
337 git config --global user.email "z.developer@example.com"
358 .. _commit-guidelines:
367 .. code-block:: none
371 [Commit message body (must be non-empty)]
373 Signed-off-by: [Your Full Name] <[your.email@address]>
380 .. code-block:: none
384 The abcd1234 sensor driver is failing to check the flags field in
389 Signed-off-by: Zephyr Developer <z.developer@example.com>
392 ---------------------------
409 * ``Bluetooth: Shell:`` for changes to the Bluetooth shell
410 * ``net: ethernet:`` for Ethernet-related networking changes
426 -------------------
441 * **how** you know it works -- for example, which tests you ran.
448 `changelog <https://github.com/zephyrproject-rtos/zephyr/commits/main>`__.
451 Signed-off-by: ...
452 ------------------
457 already. Create your commit with ``git commit -s`` to add the
458 Signed-off-by: line automatically using this information.
461 Signed-off-by: line that looks like this:
463 .. code-block:: none
465 Signed-off-by: [Your Full Name] <[your.email@address]>
470 .. code-block:: none
472 Signed-off-by: Zephyr Developer <z.developer@example.com>
481 See the :ref:`contributor-expectations` for a more complete discussion of
485 ------------
488 …https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolink…
495 .. code-block:: none
502 .. code-block:: none
510 .. code-block:: none
512 Link: https://github.com/zephyrproject-rtos/zephyr/issues/<issue number>
545 non-green) build.
555 -------------------
565 .. code-block:: bash
567 ./scripts/ci/check_compliance.py -c upstream/main..
572 interpreter, Windows will ask what application will open Perl files.
577 -------
586 If a test fails, you can check from the CI run logs how to rerun it locally,
589 .. code-block:: bash
591 west twister -p native_sim -s tests/drivers/build_all/sensor/sensors.generic_test
618 Static analysis of the Zephyr codebase is conducted on a bi-weekly basis. GitHub
663 https://github.com/zephyrproject-rtos/zephyr#fork-destination-box
675 <https://github.com/zephyrproject-rtos/zephyr>`_ from ``origin`` to
686 git remote -v
692 upstream https://github.com/zephyrproject-rtos/zephyr (fetch)
693 upstream https://github.com/zephyrproject-rtos/zephyr (push)
699 git checkout -b fix_comment_typo
704 git checkout -b fix_out_of_date_patch origin/net
706 #. Make changes, test locally, change, test, test again, ... (Check out the
710 files::
712 git add [file(s) that changed, add -p if you want to be more specific]
714 You can see files that are not yet staged using::
720 git diff --cached
724 git commit -s
726 The ``-s`` option automatically adds your ``Signed-off-by:`` to your commit
728 agreement with the :ref:`DCO`. See the :ref:`commit-guidelines` section for
749 review. Email will be sent as review comments are made, or you can check
750 on your pull request at https://github.com/zephyrproject-rtos/zephyr/pulls.
757 git checkout -b fix_another_issue
764 git rebase -i <offending-commit-id>^
768 remove the line to delete a commit entirely. Then edit files to fix the
775 git rebase --continue
779 git push --force origin fix_comment_typo
784 #. After pushing the requested change, check on the PR page if there is a
787 git fetch --all
788 git rebase --ignore-whitespace upstream/main
790 The ``--ignore-whitespace`` option stops ``git apply`` (called by rebase)
793 git push --force origin fix_comment_typo
799 one - GitHub complains it can't find older commits. You're also not
818 .. _git-rebase:
819 https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---keep-base
821 #. When pushing follow-up changes, use the ``--keep-base`` option of
822 `git-rebase`_
824 #. On the PR page, check if the change can still be merged with no merge
837 #. Revisit PR after 1-2 hours to see the status of all CI checks, make sure all
841 sure you click the "Re-request review" button on the GitHub UI to notify
856 <external-contributions>`, the commit message shall contain details regarding
857 the original project, the location of the project, the SHA-id of the origin
863 License: BSD 3-Clause
864 URL: http://www.contiki-os.org/
871 License: BSD 3-Clause
883 .. _treewide-changes:
899 do so for a wide class of external Zephyr-based source code.
913 - The zephyr repository must apply the 'treewide' GitHub label to any issues or
916 - The person proposing a treewide change must create an `RFC issue
917 …<https://github.com/zephyrproject-rtos/zephyr/issues/new?assignees=&labels=RFC&template=003_rfc-pr…
921 - The project's `Architecture Working Group (WG)
922 <https://github.com/zephyrproject-rtos/zephyr/wiki/Architecture-Working-Group>`_
928 - The Architecture WG must specify the procedure for merging any PRs associated
932 - The person proposing a treewide change must email
941 - the deprecation of version 1 of the :ref:`Logging API <logging_api>` in favor
943 <https://github.com/zephyrproject-rtos/zephyr/commit/262cc55609b73ea61b5f999c6c6daaba20bc5240>`_)
944 - the removal of support for a legacy :ref:`dt-bindings` syntax
946 <https://github.com/zephyrproject-rtos/zephyr/commit/6bf761fc0a2811b037abec0c963d60b00c452acb>`_)