You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2015/11/20 21:16:21 UTC
incubator-mynewt-site git commit: update mutex info and
sample-doc-to-edit with Will's addition
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/asf-site b9ab6abc2 -> f0ca46004
update mutex info and sample-doc-to-edit with Will's addition
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/f0ca4600
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/f0ca4600
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/f0ca4600
Branch: refs/heads/asf-site
Commit: f0ca4600441680604aa86f8803bff287f6a3f971
Parents: b9ab6ab
Author: aditihilbert <ad...@runtime.io>
Authored: Fri Nov 20 12:16:11 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Nov 20 12:16:11 2015 -0800
----------------------------------------------------------------------
chapter1/try_markdown/index.html | 3 ++
chapter4/mutex/index.html | 2 +-
index.html | 6 ++--
mkdocs/search_index.json | 12 ++++----
sitemap.xml | 56 +++++++++++++++++------------------
5 files changed, 41 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f0ca4600/chapter1/try_markdown/index.html
----------------------------------------------------------------------
diff --git a/chapter1/try_markdown/index.html b/chapter1/try_markdown/index.html
index 5f9768c..8768e0a 100644
--- a/chapter1/try_markdown/index.html
+++ b/chapter1/try_markdown/index.html
@@ -363,6 +363,9 @@
<li>
<p><font color="red"> Substitute a sentence of your own here </font></p>
</li>
+<li>
+<p><font color="red"> Guinea Pig!!! </font></p>
+</li>
</ul>
<hr />
<blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f0ca4600/chapter4/mutex/index.html
----------------------------------------------------------------------
diff --git a/chapter4/mutex/index.html b/chapter4/mutex/index.html
index 7d89dfe..db7f511 100644
--- a/chapter4/mutex/index.html
+++ b/chapter4/mutex/index.html
@@ -346,7 +346,7 @@
<div class="section">
<h1 id="mutex">Mutex<a class="headerlink" href="#mutex" title="Permanent link">¶</a></h1>
-<p>Insert synopsis here</p>
+<p>Mutex is short for "mutual exclusion"; a mutex provides mutually exclusive access to a shared resource. A mutex provides <em>priority inheritance</em> in order to prevent <em>priority inversion</em>. Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex. </p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
<p>Describe OS feature here </p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f0ca4600/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index a4492fc..ed99f0c 100644
--- a/index.html
+++ b/index.html
@@ -397,10 +397,10 @@
<p>The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. </p>
<ul>
<li>
-<p><a href="chapter1/newt_concepts/">Chapter 1: Getting Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
+<p><a href="chapter1/newt_concepts/">Chapter 1: Get Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
</li>
<li>
-<p><a href="chapter2/vocabulary/">Chapter 2: Getting Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
+<p><a href="chapter2/vocabulary/">Chapter 2: Get Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
</li>
<li>
<p><a href="chapter3/newt_ops/">Chapter 3: Newt Tool Reference</a> describes the command structure and details all the available commands to help you with your project. </p>
@@ -470,5 +470,5 @@
<!--
MkDocs version : 0.14.0
-Build Date UTC : 2015-11-20 00:53:13.473141
+Build Date UTC : 2015-11-20 20:08:29.177452
-->
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f0ca4600/mkdocs/search_index.json
----------------------------------------------------------------------
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index 860a37c..b66ebba 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -2,12 +2,12 @@
"docs": [
{
"location": "/",
- "text": "Objective of Mynewt\n\n\nMynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.\n\n\nThe world of Mynewt, therefore, has three primary collaborative goals:\n\n\n\n\nBuild a modularized real-time operating system for a rich set of hardware components\n\n\nOffer a suite of open-source software for efficient and secure two-way communications with an embedded device\n\n\nDevelop method and tools necessary to build an op
timized executable image on the desired hardware\n\n\n\n\nProject Information Links\n\n\n\n\n\n\nProject Proposal\n\n\n\n\n\n\nIssue Tracking\n\n\n\n\n\n\nProject Status\n\n\n\n\n\n\nProject GIT Repository\n\n\n\n\n\n\nDocumentation repository\n containing the markdown docs that generate the html pages you see here.\n\n\n\n\n\n\nMynewt OS development repository (larva)\n containing all code packages for newt operating system and middleware software being worked on.\n\n\n\n\n\n\nNewt tool development repository (newt)\n containing source code for the newt tool.\n\n\n\n\n\n\nMailing Lists\n\n\n\n\n\n\ndev@mynewt.incubator.apache.org \n\n\nThis is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org.\n\n\n\n\n\n\ncommits@mynewt.incubator.apache.org\n\n\nThis is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apach
e.org.\n\n\n\n\n\n\nnotifications@mynewt.incubator.apache.org\n\n\nThis is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notifications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. \n\n\n\n\n\n\nTo subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription.\n\n\nDocumentation Organization\n\n\nThe chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. \n\n\n\n\n\n\nChapter 1: Getting Started\n introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products
.\n\n\n\n\n\n\nChapter 2: Getting Acclimated\n delves deeper into the concepts crucial to the software development effort. \n\n\n\n\n\n\nChapter 3: Newt Tool Reference\n describes the command structure and details all the available commands to help you with your project. \n\n\n\n\n\n\nChapter 4: Newt OS\n provides an overview of the features available and how to customize for your hardware and software application.\n\n\n\n\n\n\nChapter 5: Modules\n lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.\n\n\n\n\n\n\nChapter 6: Creating packages for distribution\n delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.\n\n\n\n\n\n\nContributing to Documentation\n\n\nAll content on this site is statically generated using \nMkDocs\n from documents written in Markdown and stored in the \ndocs\n directory on
the master branch in the \nDocumentation repository\n. As a documentation contributor you will modify the desired markdown file or create new ones in the appropriate chapter subdirectory under \ndocs\n. \n\n\nTo edit content in a Markdown file and be able to see how the changes look you may use desktop apps such as:\n\n\n\n\nMou\n for Mac\n\n\nSomething like Mou\n for Windows\n\n\n\n\nClick on the tutorial \nHow to edit docs\n under \"Get Started\" to learn how to edit a sample file \ntry_markdown.md\n on Mynewt's documentation git repository.\n\n\nThe static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.\n\n\nIf you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in \nMkDocs\n. This step is optional but described in the tutorial.",
+ "text": "Objective of Mynewt\n\n\nMynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.\n\n\nThe world of Mynewt, therefore, has three primary collaborative goals:\n\n\n\n\nBuild a modularized real-time operating system for a rich set of hardware components\n\n\nOffer a suite of open-source software for efficient and secure two-way communications with an embedded device\n\n\nDevelop method and tools necessary to build an op
timized executable image on the desired hardware\n\n\n\n\nProject Information Links\n\n\n\n\n\n\nProject Proposal\n\n\n\n\n\n\nIssue Tracking\n\n\n\n\n\n\nProject Status\n\n\n\n\n\n\nProject GIT Repository\n\n\n\n\n\n\nDocumentation repository\n containing the markdown docs that generate the html pages you see here.\n\n\n\n\n\n\nMynewt OS development repository (larva)\n containing all code packages for newt operating system and middleware software being worked on.\n\n\n\n\n\n\nNewt tool development repository (newt)\n containing source code for the newt tool.\n\n\n\n\n\n\nMailing Lists\n\n\n\n\n\n\ndev@mynewt.incubator.apache.org \n\n\nThis is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org.\n\n\n\n\n\n\ncommits@mynewt.incubator.apache.org\n\n\nThis is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apach
e.org.\n\n\n\n\n\n\nnotifications@mynewt.incubator.apache.org\n\n\nThis is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notifications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. \n\n\n\n\n\n\nTo subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription.\n\n\nDocumentation Organization\n\n\nThe chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. \n\n\n\n\n\n\nChapter 1: Get Started\n introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.\n\
n\n\n\n\n\nChapter 2: Get Acclimated\n delves deeper into the concepts crucial to the software development effort. \n\n\n\n\n\n\nChapter 3: Newt Tool Reference\n describes the command structure and details all the available commands to help you with your project. \n\n\n\n\n\n\nChapter 4: Newt OS\n provides an overview of the features available and how to customize for your hardware and software application.\n\n\n\n\n\n\nChapter 5: Modules\n lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.\n\n\n\n\n\n\nChapter 6: Creating packages for distribution\n delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.\n\n\n\n\n\n\nContributing to Documentation\n\n\nAll content on this site is statically generated using \nMkDocs\n from documents written in Markdown and stored in the \ndocs\n directory on the mast
er branch in the \nDocumentation repository\n. As a documentation contributor you will modify the desired markdown file or create new ones in the appropriate chapter subdirectory under \ndocs\n. \n\n\nTo edit content in a Markdown file and be able to see how the changes look you may use desktop apps such as:\n\n\n\n\nMou\n for Mac\n\n\nSomething like Mou\n for Windows\n\n\n\n\nClick on the tutorial \nHow to edit docs\n under \"Get Started\" to learn how to edit a sample file \ntry_markdown.md\n on Mynewt's documentation git repository.\n\n\nThe static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.\n\n\nIf you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in \nMkDocs\n. This step is optional but described in the tutorial.",
"title": "Home"
},
{
"location": "/#objective-of-mynewt",
- "text": "Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind. The world of Mynewt, therefore, has three primary collaborative goals: Build a modularized real-time operating system for a rich set of hardware components Offer a suite of open-source software for efficient and secure two-way communications with an embedded device Develop method and tools necessary to build an optimized executable image on the desired hard
ware Project Information Links Project Proposal Issue Tracking Project Status Project GIT Repository Documentation repository containing the markdown docs that generate the html pages you see here. Mynewt OS development repository (larva) containing all code packages for newt operating system and middleware software being worked on. Newt tool development repository (newt) containing source code for the newt tool. Mailing Lists dev@mynewt.incubator.apache.org This is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. commits@mynewt.incubator.apache.org This is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apache.org. notifications@mynewt.incubator.apache.org This is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notif
ications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. To subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription. Documentation Organization The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. Chapter 1: Getting Started introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products. Chapter 2: Getting Acclimated delves deeper into the concepts crucial to the software development effort. Chapter 3: Newt Tool Reference describes the command structure and details all the avail
able commands to help you with your project. Chapter 4: Newt OS provides an overview of the features available and how to customize for your hardware and software application. Chapter 5: Modules lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components. Chapter 6: Creating packages for distribution delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management. Contributing to Documentation All content on this site is statically generated using MkDocs from documents written in Markdown and stored in the docs directory on the master branch in the Documentation repository . As a documentation contributor you will modify the desired markdown file or create new ones in the appropriate chapter subdirectory under docs . To edit content in a Markdown file and be able to see how the changes look yo
u may use desktop apps such as: Mou for Mac Something like Mou for Windows Click on the tutorial How to edit docs under \"Get Started\" to learn how to edit a sample file try_markdown.md on Mynewt's documentation git repository. The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future. If you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in MkDocs . This step is optional but described in the tutorial.",
+ "text": "Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind. The world of Mynewt, therefore, has three primary collaborative goals: Build a modularized real-time operating system for a rich set of hardware components Offer a suite of open-source software for efficient and secure two-way communications with an embedded device Develop method and tools necessary to build an optimized executable image on the desired hard
ware Project Information Links Project Proposal Issue Tracking Project Status Project GIT Repository Documentation repository containing the markdown docs that generate the html pages you see here. Mynewt OS development repository (larva) containing all code packages for newt operating system and middleware software being worked on. Newt tool development repository (newt) containing source code for the newt tool. Mailing Lists dev@mynewt.incubator.apache.org This is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. commits@mynewt.incubator.apache.org This is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apache.org. notifications@mynewt.incubator.apache.org This is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notif
ications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. To subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription. Documentation Organization The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. Chapter 1: Get Started introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products. Chapter 2: Get Acclimated delves deeper into the concepts crucial to the software development effort. Chapter 3: Newt Tool Reference describes the command structure and details all the available com
mands to help you with your project. Chapter 4: Newt OS provides an overview of the features available and how to customize for your hardware and software application. Chapter 5: Modules lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components. Chapter 6: Creating packages for distribution delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management. Contributing to Documentation All content on this site is statically generated using MkDocs from documents written in Markdown and stored in the docs directory on the master branch in the Documentation repository . As a documentation contributor you will modify the desired markdown file or create new ones in the appropriate chapter subdirectory under docs . To edit content in a Markdown file and be able to see how the changes look you may us
e desktop apps such as: Mou for Mac Something like Mou for Windows Click on the tutorial How to edit docs under \"Get Started\" to learn how to edit a sample file try_markdown.md on Mynewt's documentation git repository. The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future. If you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in MkDocs . This step is optional but described in the tutorial.",
"title": "Objective of Mynewt"
},
{
@@ -42,12 +42,12 @@
},
{
"location": "/chapter1/try_markdown/",
- "text": "Try Markdown\n\n\nHeading3\n\n\nHeading4\n\n\n\n\nList\n\n\n\n\n\n\nStart with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).\n\n\n\n\n\n\nHeading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.\n\n\n\n\n\n\nIt's \nvery\n easy to do \nbold\n and \nitalics\n.\n\n\n\n\n\n\nSee how this list has been made using *\n\n\n\n\n\n\nClick on \"Help\" in Mou and then on \"Markdown Syntax Reference\".\n\n\n\n\n\n\n Substitute a sentence of your own here \n\n\n\n\n\n\n\n\n\n\n Note! \n\n\n\n\nYou will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in \nhow_to_edit_docs.md\n.\n\n\nYou can see the change on the website if/wh
en a doc builder on the project team merges your changes to the master branch and generates the pages for the website.\n\n\nYou do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in \nhow_to_edit_docs.md\n.",
+ "text": "Try Markdown\n\n\nHeading3\n\n\nHeading4\n\n\n\n\nList\n\n\n\n\n\n\nStart with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).\n\n\n\n\n\n\nHeading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.\n\n\n\n\n\n\nIt's \nvery\n easy to do \nbold\n and \nitalics\n.\n\n\n\n\n\n\nSee how this list has been made using *\n\n\n\n\n\n\nClick on \"Help\" in Mou and then on \"Markdown Syntax Reference\".\n\n\n\n\n\n\n Substitute a sentence of your own here \n\n\n\n\n\n\n Guinea Pig!!! \n\n\n\n\n\n\n\n\n\n\n Note! \n\n\n\n\nYou will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in \nhow_to_edit_docs.md\n.\n\n\nYou can see th
e change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.\n\n\nYou do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in \nhow_to_edit_docs.md\n.",
"title": "Sample doc to edit"
},
{
"location": "/chapter1/try_markdown/#try-markdown",
- "text": "Heading3 Heading4 List Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######). Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch. It's very easy to do bold and italics . See how this list has been made using * Click on \"Help\" in Mou and then on \"Markdown Syntax Reference\". Substitute a sentence of your own here Note! You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in how_to_edit_docs.md . You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website. You
do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in how_to_edit_docs.md .",
+ "text": "Heading3 Heading4 List Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######). Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch. It's very easy to do bold and italics . See how this list has been made using * Click on \"Help\" in Mou and then on \"Markdown Syntax Reference\". Substitute a sentence of your own here Guinea Pig!!! Note! You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in how_to_edit_docs.md . You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for
the website. You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in how_to_edit_docs.md .",
"title": "Try Markdown"
},
{
@@ -292,12 +292,12 @@
},
{
"location": "/chapter4/mutex/",
- "text": "Mutex\n\n\nInsert synopsis here\n\n\nDescription\n\n\nDescribe OS feature here \n\n\nData structures\n\n\nReplace this with the list of data structures used, why, any neat features\n\n\nList of Functions\n\n\n\n\nThe functions available in this OS feature are:\n\n\n\n\nos_mutex_init\n\n\nos_mutex_release\n\n\nadd the rest\n\n\n\n\nFunction Reference\n\n\n\n\nfunction os_mutex_init\n\n\n os_error_t\n os_mutex_init(struct os_mutex *mu)\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n\n function os_mutex_re
lease\n\n\n \nInsert function callout here \n\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n\n function next_one \n\n\n \nInsert function callout here \n\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAn
y caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here",
+ "text": "Mutex\n\n\nMutex is short for \"mutual exclusion\"; a mutex provides mutually exclusive access to a shared resource. A mutex provides \npriority inheritance\n in order to prevent \npriority inversion\n. Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex. \n\n\nDescription\n\n\nDescribe OS feature here \n\n\nData structures\n\n\nReplace this with the list of data structures used, why, any neat features\n\n\nList of Functions\n\n\n\n\nThe functions available in this OS feature are:\n\n\n\n\nos_mutex_init\n\n\nos_mutex_release\n\n\nadd the rest\n\n\n\n\nFunction Reference\n\n\n\n\nfunction os_mutex_init\n\n\n os_error_t\n os_mutex_init(struct os_mutex *mu)\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexp
lain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n\n function os_mutex_release\n\n\n \nInsert function callout here \n\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here\n\n\n\n\n\n\n\n\n function next_one \n\n\n \nInsert function ca
llout here \n\n\n\n\n\n\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nxx\n\n\nexplain argument xx\n\n\n\n\n\n\nyy\n\n\nexplain argument yy\n\n\n\n\n\n\n\n\nReturned values\n\n\nList any values returned.\nError codes?\n\n\nNotes\n\n\nAny special feature/special benefit that we want to tout. \nDoes it need to be used with some other specific functions?\nAny caveats to be careful about (e.g. high memory requirements).\n\n\nExample\n\n\n\n\n\n\nInsert the code snippet here",
"title": "Mutexes"
},
{
"location": "/chapter4/mutex/#mutex",
- "text": "Insert synopsis here",
+ "text": "Mutex is short for \"mutual exclusion\"; a mutex provides mutually exclusive access to a shared resource. A mutex provides priority inheritance in order to prevent priority inversion . Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex.",
"title": "Mutex"
},
{
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f0ca4600/sitemap.xml
----------------------------------------------------------------------
diff --git a/sitemap.xml b/sitemap.xml
index 0ac7a2c..edef94c 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -13,25 +13,25 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter1/newt_concepts/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter1/project1/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter1/how_to_edit_docs/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter1/try_markdown/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -41,19 +41,19 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter2/vocabulary/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter2/project2/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter2/project3/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -63,13 +63,13 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter3/newt_ops/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter3/newt_tool_reference/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -79,73 +79,73 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/mynewt_os/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/context_switch/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/time/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/task/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/event_queue/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/semaphore/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/mutex/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/memory_pool/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/heap/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/mbufs/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/sanity/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter4/port_os/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -155,31 +155,31 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter5/console/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter5/shell/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter5/bootloader/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter5/filesystem/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter5/testutil/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -189,7 +189,7 @@
<url>
<loc>http://mynewt.incubator.apache.org/index.html/chapter6/dist/</loc>
- <lastmod>2015-11-19</lastmod>
+ <lastmod>2015-11-20</lastmod>
<changefreq>daily</changefreq>
</url>