Skip to content

Commit

Permalink
Add content license information
Browse files Browse the repository at this point in the history
 - change broken code block language.
  • Loading branch information
journey2w committed Dec 18, 2017
1 parent d256ea7 commit 6eb31d0
Show file tree
Hide file tree
Showing 14 changed files with 122 additions and 201 deletions.
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ Thank you for your interest in contributing to the Tizen documentation!

The document covers the process for contributing to the articles and code samples that are hosted on the [Tizen documentation site](https://docs.tizen.org/). Contributions may be as simple as typo corrections or as complex as new articles.

* [Process for contributing](#process-for-contributing)
* [Process for contributing](#process-for-contributing)
* [DOs and DON'Ts](#dos-and-donts)
* [Building the docs](#building-the-docs)
* [Content Licenset](#content-license)
* [Contributor License Agreement](#contributor-license-agreement)
* [Reference](#reference)


## Process for contributing

Expand Down Expand Up @@ -35,7 +37,6 @@ Navigate to the folder that corresponds to the TOC location determined for your
That folder contains the Markdown files for all articles in that section.
If necessary, create a new folder to place the files for your content. The main article for that section is called *index.md*.
For images and other static resources, create a subfolder called **media** inside the folder that contains your article, if it doesn't already exist. Inside the **media** folder, create a subfolder with the article name (except for the index file).
Include larger samples in the *samples* folder under the root of the repo.

Be sure to follow the proper Markdown syntax. For more information, see the [style guide](./styleguide/template-markdown.md).

Expand Down Expand Up @@ -121,9 +122,15 @@ The following list shows some guiding rules that you should keep in mind when yo
> you might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template-markdown.md) as well. We're working towards achieving consistency throughout the site. Check the list of [open issues](https://github.com/Samsung/tizen-docs/issues?q=is%3Aissue+is%3Aopen+label%3Aguidelines-adherence) we're currently tracking for that specific goal.

## Content License

The contents in this project are under the [Creative Commons Attribution 3.0](http://creativecommons.org/licenses/by/3.0/) License or the [BSD-3-Clause License](https://www.tizen.org/bsd-3-clause-license).
For more information, see the [Content License](content-license.md).


## Contributor License Agreement

You can read more about Contribution License Agreements (CLA) on Wikipedia.
You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.


## Reference
Expand Down
17 changes: 17 additions & 0 deletions LICENSE-CODE
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
BSD 3-Clause License

Copyright (c) Samsung Electronics Co., Ltd.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:



Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Samsung Electronics Co., Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.



THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

This repo contains Tizen documents for platform and application developers. To contribute, see the [Contributing Guide](CONTRIBUTING.md) and the [issues list](https://github.com/Samsung/tizen-docs/issues).

All files under ./docs/ are hosted on the [Tizen Docs site](https://docs.tizen.org).
All files under ./docs/ are hosted on the [Tizen Docs site](https://docs.tizen.org).

The Tizen documents in this project are licensed under the [Creative Commons Attribution 3.0](http://creativecommons.org/licenses/by/3.0/) License and the Code Examples are under the [BSD-3-Clause License](https://www.tizen.org/bsd-3-clause-license). See [Content License](content-license.md) for more details.
91 changes: 0 additions & 91 deletions TOC.html

This file was deleted.

18 changes: 18 additions & 0 deletions content-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Content License

BY ACCESSING, BROWSING OR USING THE CONTENT PAGE LINKED TO THIS LICENSE YOU ARE AGREEING TO BE BOUND BY THIS LICENSE.

The content linked to this license is divided into two categories: (1) Code Examples which include the code examples therein; and (2) The Other Contents which exclude the code examples.

Unless otherwise stated, the Other Contents are under the [Creative Commons Attribution 3.0](http://creativecommons.org/licenses/by/3.0/) License and the Code Examples are under the [BSD-3-Clause License](https://www.tizen.org/bsd-3-clause-license).

For The Other Contents, we ask that you give proper attribution per section 4b of [Creative Commons 3.0 Legal Code](http://creativecommons.org/licenses/by/3.0/legalcode).

If a page includes content (e.g., links to the video, slide decks or images) from any source other than the tizen.org websites, such content is not covered by this license unless specifically noted.

All logos, trademarks and other brand features contained on tizen.org websites are and remain the property of their respective owners. No licenses or other rights in or to such logos and/or trademarks and/or other brand features are granted. Please see the [linked, pertinent guideline](https://www.tizen.org/about/tizen-brand-guidelines).


- Change Log
- June 17, 2013
Specified that Code Examples are under the BSD-3-Clause license.
15 changes: 1 addition & 14 deletions docs/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
### [Kernel](open-source-project/porting/kernel.md)
### [System](open-source-project/porting/system.md)
### [Graphics and UI](open-source-project/porting/graphics-and-ui.md)
### [Recovery](open-source-project/porting/recovery.md)
### [Multimedia](open-source-project/porting/multimedia.md)
### [Connectivity](open-source-project/porting/connectivity.md)
### [Location](open-source-project/porting/location.md)
Expand Down Expand Up @@ -81,17 +82,3 @@
### Release Notes
#### [Tizen RT 1.0 M1](open-source-project/tizen-rt/release-notes/tizen-rt-1-0-m1.md)
<!-- End of Tizen Platform -->

<!-- Tizen .NET Content -->
# <!--Tizen .NET (TBD)-->
## <!--Getting Started-->
## <!--Guides-->
## <!--API Reference-->
## <!--VS Tools-->
## <!--Samples-->
<!-- End of Tizen .NET -->

<!-- Tizen Native/Web Application Content -->
# <!--Tizen Native/Web Application (TBD)-->
<!-- End of Tizen Native/Web Application -->

8 changes: 4 additions & 4 deletions docs/open-source-project/porting/connectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ During initialization, the `nfc-manager` loads the `nfc-plugin.so` library, sear
The following example shows the `onload()` function:
```c
```cpp
Bool
onload(net_nfc_oem_interface_s *oem_interfaces) {
oem_interfaces->init = xxx; /* xxx refers to plugin APIs */
Expand All @@ -268,7 +268,7 @@ onload(net_nfc_oem_interface_s *oem_interfaces) {

The NFC OAL interfaces are defined in the following structure. Use the `net_nfc_oem_controller.h` header file.

```c
```cpp
typedef struct _net_nfc_oem_interface_s {
net_nfc_oem_controller_init init;
net_nfc_oem_controller_deinit deinit;
Expand Down Expand Up @@ -318,13 +318,13 @@ typedef struct _net_nfc_oem_interface_s {
The `nfc_oem_interface_s` struct is exported in the `nfc-plugin`. Using this interface structure, the `nfc-manager` communicates with the OAL interfaces at runtime. The NFC plugin loads when the `nfc-manager` is started and the plugin `init()` function is called to initialize the NFC chip.
```c
```cpp
int (*init) (net_nfc_oem_controller_init*);
```

The `nfc-manager` issues the `deinit()` function to deinitialize the NFC chip:

```c
```cpp
int (*deinit) (net_nfc_oem_controller_deinit *);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/open-source-project/porting/graphics-and-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ lrwxrwxrwx 1 root root 14 Jul 28 2016 libtdm-default.so -> libtdm-drm.so

The TDM backend module must define the global data symbol with the name `tdm_backend_module_data`. The TDM frontend reads this symbol at the initialization time. TDM calls the `init()` function of the `tdm_backend_module_data`. For more information, see [tdm_backend.h](https://review.tizen.org/gerrit/gitweb?p=platform/core/uifw/libtdm.git;a=tree;h=refs/heads/tizen;hb=refs/heads/tizen).

```c
```cpp
typedef struct _tdm_backend_module {
const char *name; /* The module name of the backend module */
const char *vendor; /* The vendor name of the backend module */
Expand Down Expand Up @@ -295,7 +295,7 @@ tdm_backend_module tdm_backend_module_data = {

The TDM backend must register the `tdm_func_display()`, `tdm_func_output()`, and `tdm_func_layer()` functions with the `tdm_backend_register_func_display()`, `tdm_backend_register_func_output()`, and `tdm_backend_register_func_layer()` functions in the `tdm_backend_module_data` `init()` function.

```c
```cpp
#include <tdm_backend.h>

tdm_backend_data*
Expand Down Expand Up @@ -615,7 +615,7 @@ The following figure illustrates the OpenGL&reg; ES drawing API flow.

The following code snippet shows a simple example of the Tizen Porting Layer:

```c
```cpp
dpy = tpl_display_create(...);
sfc = tpl_surface_create(dpy, ...);

Expand Down
20 changes: 10 additions & 10 deletions docs/open-source-project/porting/location.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The `lbs-server-plugin-dev` package source files can be found in the following d

The `gps_plugin_intf.h` header file includes the API interfaces for the communication between the lbs-server and its GPS plugin.

```c
```cpp
typedef struct {
/* Initialize the plugin module and register callback function for event delivery */
int (*init) (gps_event_cb gps_event_cb, void *user_data);
Expand All @@ -59,25 +59,25 @@ typedef struct {
} gps_plugin_interface;
```
```c
```cpp
const gps_plugin_interface *get_gps_plugin_interface();
```

The `get_gps_plugin_interface()` function must be exported in the GPS plugin. It gives the `gps_plugin_interface` structure to the lbs-server, and the lbs-server communicates through these interfaces. When the lbs-server is started, the GPS plugin is loaded and the `init()` function is called. At this moment, a GPS device must be initialized.

```c
```cpp
int (*init) (gps_event_cb gps_event_cb, void *user_data);
```

When the `init()` function is called, the `gps_event_cb` callback is set. GPS events and data from a GPS device are delivered through the callback.

```c
```cpp
typedef int (*gps_event_cb) (gps_event_info_t *gps_event_info, void *user_data);
```
The following example describes the GPS events:
```c
```cpp
typedef enum {
GPS_EVENT_START_SESSION = 0x0000, /* The session is started */
GPS_EVENT_STOP_SESSION, /* The session is stopped */
Expand All @@ -99,13 +99,13 @@ typedef enum {

The GPS events contain specific GPS event data which is part of the delivered `gps_event_data_t` (see the `gps_plugin_intf.h` file). When the lbs-server wants to make a request to a GPS device, the `request()` function is called:

```c
```cpp
int (*request) (gps_action_t gps_action, void *gps_action_data, gps_failure_reason_t *reason_code);
```

Each request is classified by `gps_action_t`.

```c
```cpp
typedef enum {
GPS_ACTION_SEND_PARAMS = 0x00,
GPS_ACTION_START_SESSION,
Expand All @@ -124,7 +124,7 @@ With the standalone GPS (unassisted GPS), the `GPS_ACTION_START_SESSION` and `GP

To shut down the lbs-server, deinitialize the GPS device with the `deinit()` function:

```c
```cpp
int (*deinit) (gps_failure_reason_t *reason_code);
```

Expand All @@ -134,7 +134,7 @@ The `check_plugin_module(char* module_name)` function checks the access to the a

Add the necessary path definitions:

```c
```cpp
#define PLATFORM_PATH "/sys/devices/platform"
#define PLUGIN_PATH PLATFORM_PATH"/xxxxx_gps"
```
Expand Down Expand Up @@ -197,7 +197,7 @@ The `capi-maps-service-plugin-devel` package source files can be found in the fo

The `module.h` header file includes the API interfaces for the communication between the Maps and its plugin.

```c
```cpp
typedef struct _interface_s {
/* Plugin dedicated functions */
maps_plugin_init_f maps_plugin_init;
Expand Down
Loading

0 comments on commit 6eb31d0

Please sign in to comment.