You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2017/12/19 00:36:34 UTC
[GitHub] aditihilbert closed pull request #705: fix .rst errors in md->rst conversion
aditihilbert closed pull request #705: fix .rst errors in md->rst conversion
URL: https://github.com/apache/mynewt-core/pull/705
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/faq/answers.rst b/docs/faq/answers.rst
index 5710df7b5..270e9d76b 100644
--- a/docs/faq/answers.rst
+++ b/docs/faq/answers.rst
@@ -4,15 +4,17 @@ FAQ
Here are some lists, grouped by categories, of frequently asked
questions.
-**Mynewt software questions:**
+Mynewt software questions:
+~~~~~~~~~~~~~~~~~~~~~~~~~~
- `How do I reduce the code size for my Mynewt
image? </os/tutorials/codesize/>`__
-**Administrative questions:**
+Administrative questions:
+~~~~~~~~~~~~~~~~~~~~~~~~~
-- `How do I submit a bug? <#submit-a-bug>`__
-- `How do I request a feature? <#request-feature>`__
+- `How do I submit a bug? <#how-do-i-submit-a-bug>`__
+- `How do I request a feature? <#how-do-i-request-a-feature>`__
- `How do I submit a patch if I am not a
committer? <#not-committer-patch>`__
- `Can I merge my own Pull Request into the git repo if I am a
@@ -21,7 +23,10 @@ questions.
- `How do I make changes to documentation using an editor on my
laptop? <#doc-editor>`__
- ### How do I submit a bug? If you do not have a JIRA account sign up
+How do I submit a bug?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you do not have a JIRA account sign up
for an account on
`JIRA <https://issues.apache.org/jira/secure/Signup!default.jspa>`__.
@@ -34,10 +39,10 @@ Log in. Choose the "MYNEWT" project. Click on the "Create" button to
create a ticket. Choose "Bug" as the Issue Type. Fill in the bug
description, how it is triggered, and other details.
- How do I request a feature?
+How do I request a feature?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- If you do not have a JIRA account sign up for an account on
+If you do not have a JIRA account sign up for an account on
`JIRA <https://issues.apache.org/jira/secure/Signup!default.jspa>`__.
Submit a request to the @dev mailing list for your JIRA username to be
@@ -54,28 +59,34 @@ If you are not a committer and you wish to work on it, someone who is on
the committer list will have to review your request and assign it to
you. You will have to refer to this JIRA ticket in your pull request.
+.. _not-committer-patch:
+
I am not on the committer list. How do I submit a patch?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- **You submit your proposed changes for your peers with committer status
+**You submit your proposed changes for your peers with committer status
to review and merge.**
The process to submit a Pull Request on github.com is described on the
`Confluence page for the
project <https://cwiki.apache.org/confluence/display/MYNEWT/Submitting+Pull+Requests>`__.
+.. _committer-merge:
+
I am a committer in the project. Can I merge my own Pull Request into the git repository?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Yes, but only if your Pull Request has been reviewed and approved by
+Yes, but only if your Pull Request has been reviewed and approved by
another committer in Apache Mynewt. The process to merge a Pull Request
is described on the `Confluence page for the
project <https://cwiki.apache.org/confluence/display/MYNEWT/Merging+Pull+Requests>`__.
+.. _change-doc:
+
I would like to make some edits to the documentation. What do I do?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- You submit your proposed changes for your peers with committer status
+You submit your proposed changes for your peers with committer status
to review and merge.
Go to the `documentation
@@ -107,10 +118,12 @@ If you want to withdraw the pull request simply go to your fork
"branches". You should see your branch under "Your branches". Click on
the delete icon.
+.. _doc-editor:
+
I would like to make some edits to the documentation but want to use an editor on my own laptop. What do I do?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- You submit your proposed changes for your peers with committer status
+You submit your proposed changes for your peers with committer status
to review and merge.
Go to the `documentation
diff --git a/docs/index.rst b/docs/index.rst
index a468d504b..64ab351f9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,6 +13,7 @@ Mynewt Documentation
newt/newt_intro
newtmgr/overview
known_issues
+ FAQ <faq/answers>
Welcome to Apache Mynewt
diff --git a/docs/newt/install/newt_mac.rst b/docs/newt/install/newt_mac.rst
index c616fc91b..1faa5317e 100644
--- a/docs/newt/install/newt_mac.rst
+++ b/docs/newt/install/newt_mac.rst
@@ -4,11 +4,12 @@ Installing Newt on Mac OS
Newt is supported on Mac OS X 64 bit platforms and has been tested on
Mac OS 10.10 and higher.
-This page shows you how to install the following versions of newt:
+This page shows you how to:
-- Upgrade to or install the latest release version (1.1.0).
-- Install earlier release versions.
-- Install the latest from the master branch (unstable).
+- Upgrade to or install the latest release version of newt.
+- Install the latest newt from the master branch (unstable).
+
+See `Installing Previous Releases of Newt <prev_releases>`__ to install an earlier version of newt.
**Note:** If you would like to contribute to the newt tool, see `Setting
Up Go Environment to Contribute to Newt and Newtmgr
diff --git a/docs/os/core_os/event_queue/event_queue.rst b/docs/os/core_os/event_queue/event_queue.rst
index 065335453..b8f2f7606 100644
--- a/docs/os/core_os/event_queue/event_queue.rst
+++ b/docs/os/core_os/event_queue/event_queue.rst
@@ -75,38 +75,17 @@ fields:
STAILQ_ENTRY(os_event) ev_next;
};
-+------------+----------------+
-| Element | Description |
-+============+================+
-| ``ev_queue | Internal field |
-| d`` | that indicates |
-| | whether this |
-| | event is |
-| | currently |
-| | linked to an |
-| | event queue |
-+------------+----------------+
-| ``ev_cb`` | Pointer to the |
-| | callback |
-| | function to |
-| | call to |
-| | process this |
-| | event |
-+------------+----------------+
-| ``ev_arg`` | Pointer to an |
-| | optional |
-| | opaque data |
-| | that the |
-| | callback |
-| | function uses |
-| | to process |
-| | this event |
-+------------+----------------+
-| ``ev_next` | Linkage |
-| ` | attaching this |
-| | event to an |
-| | event queue |
-+------------+----------------+
++-----------------+--------------------------------------------------------------------------------------------+
+| Element | Description |
++=================+============================================================================================+
+| ``ev_queued`` | Internal field that indicates whether this event is currently linked to an event queue |
++-----------------+--------------------------------------------------------------------------------------------+
+| ``ev_cb`` | Pointer to the callback function to call to process this event |
++-----------------+--------------------------------------------------------------------------------------------+
+| ``ev_arg`` | Pointer to an optional opaque data that the callback function uses to process this event |
++-----------------+--------------------------------------------------------------------------------------------+
+| ``ev_next`` | Linkage attaching this event to an event queue |
++-----------------+--------------------------------------------------------------------------------------------+
An event callback function has the following function prototype:
@@ -138,9 +117,7 @@ in the NimBLE host:
.ev_cb = ble_hs_event_tx_notify,
};
-|
-| The ``os_eventq`` structure defines an event queue and has the
- following fields:
+The ``os_eventq`` structure defines an event queue and has the following fields:
.. code:: c
@@ -149,26 +126,14 @@ in the NimBLE host:
STAILQ_HEAD(, os_event) evq_list;
};
-+------------+----------------+
-| Element | Description |
-+============+================+
-| ``evq_task | Pointer to the |
-| `` | task, if any, |
-| | that is |
-| | waiting (in |
-| | the |
-| | ``sleeping`` |
-| | state) for the |
-| | ``os_eventq_ge |
-| | t()`` |
-| | function to |
-| | return an |
-| | event |
-+------------+----------------+
-| ``evq_list | Head of the |
-| `` | list of events |
-| | in this queue |
-+------------+----------------+
++----------------+------------------------------------------------------------------------------------------------------------------------------------+
+| Element | Description |
++================+====================================================================================================================================+
+| ``evq_task`` | Pointer to the task, if any, that is waiting (in the ``sleeping`` state) for the ``os_eventq_get()`` function to return an event |
++----------------+------------------------------------------------------------------------------------------------------------------------------------+
+| ``evq_list`` | Head of the list of events in this queue |
++----------------+------------------------------------------------------------------------------------------------------------------------------------+
+
You must call the ``os_eventq_init()`` function to initialize an event
queue before you can add events to the queue.
@@ -178,5 +143,3 @@ API
.. doxygengroup:: OSEvent
:content-only:
-
-
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig1.png b/docs/os/core_os/mbuf/pics/mbuf_fig1.png
new file mode 100644
index 000000000..ba7ab0fb7
Binary files /dev/null and b/docs/os/core_os/mbuf/pics/mbuf_fig1.png differ
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig2.png b/docs/os/core_os/mbuf/pics/mbuf_fig2.png
new file mode 100644
index 000000000..68a971628
Binary files /dev/null and b/docs/os/core_os/mbuf/pics/mbuf_fig2.png differ
diff --git a/docs/os/core_os/mbuf/pics/mbuf_fig3.png b/docs/os/core_os/mbuf/pics/mbuf_fig3.png
new file mode 100644
index 000000000..6d5ac5b4f
Binary files /dev/null and b/docs/os/core_os/mbuf/pics/mbuf_fig3.png differ
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services