Skip to content

Commit

Permalink
doc: move documetnation context to root directory
Browse files Browse the repository at this point in the history
This will allow inclusion of documentation files that exist outside of
doc/ and will make it possible to add rst files across the tree,
especially for boards, samples and tests.

Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294
Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
nashif authored and Anas Nashif committed Jan 6, 2017
1 parent eaa06ac commit fc61370
Show file tree
Hide file tree
Showing 14 changed files with 548 additions and 451 deletions.
2 changes: 1 addition & 1 deletion .known-issues/doc/header_footer.conf
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
^srctree=.* SRCARCH=\w+ python scripts/genrest/genrest.py .*$
# This cuts the sphinx build line; has to be separate because in the
# middle, we have removed the KERNELVERSION one and a full regex won't match
^sphinx-build -t \w+ -b html -d [-._/\w]+ -q \. .*
^sphinx-build -t \w+ -b html .*
#
# Documentation generation, footer message
#
Expand Down
66 changes: 0 additions & 66 deletions LICENSING.rst

This file was deleted.

66 changes: 65 additions & 1 deletion doc/LICENSING.rst
Original file line number Diff line number Diff line change
@@ -1 +1,65 @@
.. include:: ../LICENSING.rst
.. _zephyr_licensing:

Licensing of Zephyr Project components
######################################

The Zephyr kernel tree imports or reuses packages, scripts and other files that
are not covered by the :download:`Apache License <../LICENSE>`. In some places
there is no LICENSE file or way to put a LICENSE file there, so we describe the
licensing in this document.


- *kconfig* and *kbuild*

*Origin:* Linux Kernel
*Licensing:* *GPLv2*

- *scripts/{checkpatch.pl,checkstack.pl,get_maintainers.pl,spelling.txt}*

*Origin:* Linux Kernel
*Licensing:* *GPLv2*

- *ext/fs/fat/*

*Origin:* FatFs is a file system based on the FAT file system specification. This is
provided by ELM Chan http://elm-chan.org/fsw/ff/00index_e.html

*Licensing*:

Copyright (C) 2016, ChaN, all right reserved.

FatFs module is an open source software. Redistribution and use of FatFs in
source and binary forms, with or without modification, are permitted provided
that the following condition is met:

1. Redistributions of source code must retain the above copyright notice,
this condition and the following disclaimer.

This software is provided by the copyright holder and contributors "AS IS"
and any warranties related to this software are DISCLAIMED.
The copyright owner or contributors be NOT LIABLE for any damages caused
by use of this software.

- *ext/hal/cmsis/*

*Origin:* https://github.com/ARM-software/CMSIS.git

*Licensing*: :download:`CMSIS_END_USER_LICENCE_AGREEMENT <../ext/hal/cmsis/CMSIS_END_USER_LICENCE_AGREEMENT.pdf>`

- *ext/hal/ksdk/*

*Origin:* http://kex.nxp.com

*Licensing*: 3-clause BSD (see :download:`source <../ext/hal/ksdk/drivers/fsl_rtc.h>`)

- *ext/hal/nordic/*

*Origin:*

*Licensing*: 3-clause BSD (see :download:`source <../ext/hal/nordic/mdk/nrf51.h>`)

- *ext/hal/qmsi/*

*Origin:* https://github.com/quark-mcu/qmsi/releases

*Licensing*: 3-clause BSD (see :download:`source <../ext/hal/qmsi/include/qm_common.h>`)
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
ALLSPHINXOPTS = -c $(ZEPHYR_BASE)/doc -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(ZEPHYR_BASE)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

Expand Down
Loading

0 comments on commit fc61370

Please sign in to comment.