Repository: incubator-mynewt-site Updated Branches: refs/heads/os_xxx_delete [created] 26867f1d6
Removal of os_mutex_delete and os_sem_delete from the documentation as they are no longer in the code 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/26867f1d Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/26867f1d Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/26867f1d Branch: refs/heads/os_xxx_delete Commit: 26867f1d60ac5e1cd62c3f7e9a4ab7e00f0b2ec9 Parents: 9ee8142 Author: wes3 <w...@micosa.io> Authored: Wed Mar 2 14:02:40 2016 -0800 Committer: wes3 <w...@micosa.io> Committed: Wed Mar 2 14:02:40 2016 -0800 ---------------------------------------------------------------------- docs/os/core_os/mutex/mutex.md | 1 - docs/os/core_os/mutex/os_mutex_delete.md | 33 ---------------------- docs/os/core_os/semaphore/os_sem_delete.md | 37 ------------------------- docs/os/core_os/semaphore/semaphore.md | 1 - mkdocs.yml | 2 -- 5 files changed, 74 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/26867f1d/docs/os/core_os/mutex/mutex.md ---------------------------------------------------------------------- diff --git a/docs/os/core_os/mutex/mutex.md b/docs/os/core_os/mutex/mutex.md index 08b9487..f053e31 100644 --- a/docs/os/core_os/mutex/mutex.md +++ b/docs/os/core_os/mutex/mutex.md @@ -41,7 +41,6 @@ struct os_mutex The functions available in this OS feature are: -* [os_mutex_delete](os_mutex_delete) * [os_mutex_init](os_mutex_init) * [os_mutex_pend](os_mutex_pend) * [os_mutex_release](os_mutex_release) http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/26867f1d/docs/os/core_os/mutex/os_mutex_delete.md ---------------------------------------------------------------------- diff --git a/docs/os/core_os/mutex/os_mutex_delete.md b/docs/os/core_os/mutex/os_mutex_delete.md deleted file mode 100644 index 29155b6..0000000 --- a/docs/os/core_os/mutex/os_mutex_delete.md +++ /dev/null @@ -1,33 +0,0 @@ -## <font color="#F2853F" style="font-size:24pt">os_mutex_delete </font> - -```no-highlight -os_error_t os_mutex_pend(struct os_mutex *mu) -``` - -Delete a mutex - -#### Arguments - -| Arguments | Description | -|-----------|-------------| -| *mu | Pointer to mutex | - -#### Returned values - -OS_INVALID_PARM: returned when *mu is NULL on entry. - -OS_OK: mutex initialized successfully. - -OS_NOT_STARTED: Attempt to release a mutex before the os has been started. - -#### Example - -```no-highlight -struct os_mutex g_mutex1; -os_error_t err; - -err = os_mutex_delete(&g_mutex1); -assert(err == OS_OK); -``` - ---------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/26867f1d/docs/os/core_os/semaphore/os_sem_delete.md ---------------------------------------------------------------------- diff --git a/docs/os/core_os/semaphore/os_sem_delete.md b/docs/os/core_os/semaphore/os_sem_delete.md deleted file mode 100644 index 26a340d..0000000 --- a/docs/os/core_os/semaphore/os_sem_delete.md +++ /dev/null @@ -1,37 +0,0 @@ -## <font color="#F2853F" style="font-size:24pt"> os_sem_delete </font> - -```no-highlight -os_error_t os_sem_delete(struct os_sem *sem) -``` - -Delete a semaphore - -#### Arguments - -| Arguments | Description | -|-----------|-------------| -| *sem | Pointer to semaphore | - -#### Returned values - -OS_INVALID_PARM: returned when *sem is NULL on entry. - -OS_OK: semaphore deleted successfully. - -OS_NOT_STARTED: Attempt to release a semaphore before os started. - -#### Notes - -Care must be taken when deleting a semaphore as deleting a semaphore used by other tasks could causes unexpected/unwanted behavior. - -#### Example - -```no-highlight -struct os_sem g_os_sem; -os_error_t err; - -err = os_sem_delete(&g_os_sem); -assert(err == OS_OK); -``` - ---------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/26867f1d/docs/os/core_os/semaphore/semaphore.md ---------------------------------------------------------------------- diff --git a/docs/os/core_os/semaphore/semaphore.md b/docs/os/core_os/semaphore/semaphore.md index b36a624..cbf7abc 100644 --- a/docs/os/core_os/semaphore/semaphore.md +++ b/docs/os/core_os/semaphore/semaphore.md @@ -35,7 +35,6 @@ struct os_sem The functions available in semaphore are: -* [os_sem_delete](os_sem_delete) * [os_sem_init](os_sem_init) * [os_sem_pend](os_sem_pend) * [os_sem_release](os_sem_release) http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/26867f1d/mkdocs.yml ---------------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index 517647d..3760314 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,14 +64,12 @@ pages: - Semaphores: - 'Overview': 'os/core_os/semaphore/semaphore.md' - 'Functions': - - 'os_sem_delete': 'os/core_os/semaphore/os_sem_delete.md' - 'os_sem_init': 'os/core_os/semaphore/os_sem_init.md' - 'os_sem_pend': 'os/core_os/semaphore/os_sem_pend.md' - 'os_sem_release': 'os/core_os/semaphore/os_sem_release.md' - Mutexes: - 'Overview': 'os/core_os/mutex/mutex.md' - 'Functions': - - 'os_mutex_delete': 'os/core_os/mutex/os_mutex_delete.md' - 'os_mutex_init': 'os/core_os/mutex/os_mutex_pend.md' - 'os_mutex_release': 'os/core_os/mutex/os_mutex_release.md' - Memory Pools:
