Return-Path: X-Original-To: apmail-mynewt-commits-archive@minotaur.apache.org Delivered-To: apmail-mynewt-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 3EB0D1823A for ; Thu, 25 Feb 2016 22:41:44 +0000 (UTC) Received: (qmail 20477 invoked by uid 500); 25 Feb 2016 22:41:44 -0000 Delivered-To: apmail-mynewt-commits-archive@mynewt.apache.org Received: (qmail 20447 invoked by uid 500); 25 Feb 2016 22:41:44 -0000 Mailing-List: contact commits-help@mynewt.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@mynewt.incubator.apache.org Delivered-To: mailing list commits@mynewt.incubator.apache.org Received: (qmail 20438 invoked by uid 99); 25 Feb 2016 22:41:44 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 25 Feb 2016 22:41:44 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 7A3A1C09AA for ; Thu, 25 Feb 2016 22:41:43 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 3.781 X-Spam-Level: *** X-Spam-Status: No, score=3.781 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_BADIPHTTP=2, KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, WEIRD_PORT=0.001] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id hX-OCGCwgCuX for ; Thu, 25 Feb 2016 22:41:39 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id BAB7D5FAC9 for ; Thu, 25 Feb 2016 22:41:37 +0000 (UTC) Received: (qmail 20421 invoked by uid 99); 25 Feb 2016 22:41:36 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 25 Feb 2016 22:41:36 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D1CA9E8F37; Thu, 25 Feb 2016 22:41:36 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: aditi@apache.org To: commits@mynewt.incubator.apache.org Date: Thu, 25 Feb 2016 22:41:39 -0000 Message-Id: <8218300a0a5b4336b988ae30fa2c2174@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [4/4] incubator-mynewt-site git commit: Update community page & contribution steps Update community page & contribution steps 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/27438146 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/27438146 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/27438146 Branch: refs/heads/asf-site Commit: 274381469a7d54cd5e2f5d1612f41737ff1c1471 Parents: 0760c39 Author: aditihilbert Authored: Thu Feb 25 14:40:55 2016 -0800 Committer: aditihilbert Committed: Thu Feb 25 14:40:55 2016 -0800 ---------------------------------------------------------------------- community/index.html | 13 +- documentation/index.html | 2 +- download/index.html | 2 +- events/index.html | 2 +- index.html | 2 +- mkdocs/search_index.json | 87 ++- newt/command_list/newt_app/index.html | 2 +- newt/command_list/newt_help/index.html | 2 +- newt/command_list/newt_new/index.html | 2 +- newt/command_list/newt_pkg/index.html | 2 +- newt/command_list/newt_target/index.html | 2 +- newt/command_list/newt_version/index.html | 2 +- newt/newt_intro/index.html | 2 +- newt/newt_linux/index.html | 2 +- newt/newt_mac/index.html | 2 +- newt/newt_ops/index.html | 2 +- newt/packaging/dist/index.html | 2 +- newtmgr/overview/index.html | 2 +- newtmgr/project-slinky/index.html | 2 +- newtmgr/protocol/index.html | 2 +- os/core_os/callout/callout/index.html | 2 +- .../callout/os_callout_func_init/index.html | 2 +- os/core_os/callout/os_callout_init/index.html | 2 +- os/core_os/callout/os_callout_queued/index.html | 2 +- os/core_os/callout/os_callout_reset/index.html | 2 +- os/core_os/callout/os_callout_stop/index.html | 2 +- .../context_switch/context_switch/index.html | 2 +- os/core_os/context_switch/os_sched/index.html | 2 +- .../os_sched_ctx_sw_hook/index.html | 2 +- .../os_sched_get_current_task/index.html | 2 +- .../context_switch/os_sched_insert/index.html | 2 +- .../os_sched_next_task/index.html | 2 +- .../os_sched_os_timer_exp/index.html | 2 +- .../context_switch/os_sched_resort/index.html | 2 +- .../os_sched_set_current_task/index.html | 2 +- .../context_switch/os_sched_sleep/index.html | 2 +- .../context_switch/os_sched_wakeup/index.html | 2 +- os/core_os/event_queue/event_queue/index.html | 2 +- os/core_os/event_queue/os_eventq_get/index.html | 2 +- .../event_queue/os_eventq_init/index.html | 2 +- os/core_os/event_queue/os_eventq_put/index.html | 2 +- .../event_queue/os_eventq_put2/index.html | 2 +- .../event_queue/os_eventq_remove/index.html | 2 +- os/core_os/heap/heap/index.html | 2 +- os/core_os/heap/os_free/index.html | 2 +- os/core_os/heap/os_malloc/index.html | 2 +- os/core_os/heap/os_realloc/index.html | 2 +- os/core_os/mbuf/_os_mbuf_copypkthdr/index.html | 717 +++++++++++++++++++ os/core_os/mbuf/_os_msys_find_pool/index.html | 717 +++++++++++++++++++ os/core_os/mbuf/mbuf/index.html | 8 +- os/core_os/mbuf/os_mbuf_adj/index.html | 20 +- os/core_os/mbuf/os_mbuf_append/index.html | 20 +- os/core_os/mbuf/os_mbuf_concat/index.html | 20 +- os/core_os/mbuf/os_mbuf_copydata/index.html | 20 +- os/core_os/mbuf/os_mbuf_copyinto/index.html | 20 +- os/core_os/mbuf/os_mbuf_dup/index.html | 20 +- os/core_os/mbuf/os_mbuf_extend/index.html | 20 +- os/core_os/mbuf/os_mbuf_free/index.html | 20 +- os/core_os/mbuf/os_mbuf_free_chain/index.html | 20 +- os/core_os/mbuf/os_mbuf_get/index.html | 20 +- os/core_os/mbuf/os_mbuf_get_pkthdr/index.html | 20 +- os/core_os/mbuf/os_mbuf_memcmp/index.html | 20 +- os/core_os/mbuf/os_mbuf_off/index.html | 20 +- os/core_os/mbuf/os_mbuf_pool_init/index.html | 20 +- os/core_os/mbuf/os_mbuf_prepend/index.html | 20 +- os/core_os/mbuf/os_mbuf_pullup/index.html | 20 +- os/core_os/mbuf/os_mqueue_get/index.html | 20 +- os/core_os/mbuf/os_mqueue_init/index.html | 20 +- os/core_os/mbuf/os_mqueue_put/index.html | 20 +- os/core_os/mbuf/os_msys_get/index.html | 20 +- os/core_os/mbuf/os_msys_get_pkthdr/index.html | 20 +- os/core_os/mbuf/os_msys_register/index.html | 20 +- os/core_os/mbuf/os_msys_reset/index.html | 20 +- .../memory_pool/OS_MEMPOOL_BYTES/index.html | 2 +- .../memory_pool/OS_MEMPOOL_SIZE/index.html | 2 +- os/core_os/memory_pool/memory_pool/index.html | 2 +- .../memory_pool/os_memblock_get/index.html | 2 +- .../memory_pool/os_memblock_put/index.html | 2 +- .../memory_pool/os_mempool_init/index.html | 2 +- os/core_os/mutex/mutex/index.html | 2 +- os/core_os/mutex/os_mutex_delete/index.html | 2 +- os/core_os/mutex/os_mutex_pend/index.html | 2 +- os/core_os/mutex/os_mutex_release/index.html | 2 +- os/core_os/mynewt_os/index.html | 2 +- os/core_os/os_init/index.html | 2 +- os/core_os/os_start/index.html | 2 +- os/core_os/os_started/index.html | 2 +- os/core_os/port_os/index.html | 2 +- .../sanity/os_sanity_check_init/index.html | 2 +- .../sanity/os_sanity_check_list_lock/index.html | 2 +- .../os_sanity_check_list_unlock/index.html | 2 +- .../sanity/os_sanity_check_register/index.html | 2 +- .../sanity/os_sanity_check_reset/index.html | 2 +- .../sanity/os_sanity_task_init/index.html | 2 +- os/core_os/sanity/sanity/index.html | 2 +- os/core_os/semaphore/os_sem_delete/index.html | 2 +- os/core_os/semaphore/os_sem_init/index.html | 2 +- os/core_os/semaphore/os_sem_pend/index.html | 2 +- os/core_os/semaphore/os_sem_release/index.html | 2 +- os/core_os/semaphore/semaphore/index.html | 2 +- os/core_os/task/_clear_stack/index.html | 565 +++++++++++++++ os/core_os/task/os_task_count/index.html | 20 +- .../task/os_task_info_get_next/index.html | 20 +- os/core_os/task/os_task_init/index.html | 20 +- os/core_os/task/os_task_next_id/index.html | 565 +++++++++++++++ .../task/os_task_sanity_checkin/index.html | 20 +- os/core_os/task/task/index.html | 8 +- os/core_os/time/os_time_delay/index.html | 2 +- os/core_os/time/os_time_get/index.html | 2 +- os/core_os/time/os_time_tick/index.html | 2 +- os/core_os/time/time/index.html | 2 +- os/get_acclimated/how_to_edit_docs/index.html | 424 +++++++++++ os/get_acclimated/project2/index.html | 18 +- os/get_acclimated/project3/index.html | 12 +- os/get_started/introduction/index.html | 2 +- os/get_started/project1/index.html | 2 +- os/get_started/vocabulary/index.html | 2 +- os/modules/baselibc/index.html | 2 +- .../bootloader/boot_build_status/index.html | 2 +- .../bootloader/boot_build_status_one/index.html | 2 +- .../bootloader/boot_clear_status/index.html | 2 +- os/modules/bootloader/boot_copy_area/index.html | 2 +- .../bootloader/boot_copy_image/index.html | 2 +- .../bootloader/boot_erase_area/index.html | 2 +- os/modules/bootloader/boot_fill_slot/index.html | 2 +- .../boot_find_image_area_idx/index.html | 2 +- .../bootloader/boot_find_image_part/index.html | 2 +- .../bootloader/boot_find_image_slot/index.html | 2 +- os/modules/bootloader/boot_go/index.html | 2 +- .../bootloader/boot_init_flash/index.html | 2 +- os/modules/bootloader/boot_move_area/index.html | 2 +- .../boot_read_image_header/index.html | 2 +- .../boot_read_image_headers/index.html | 2 +- .../bootloader/boot_read_status/index.html | 2 +- .../boot_select_image_slot/index.html | 2 +- os/modules/bootloader/boot_slot_addr/index.html | 2 +- .../bootloader/boot_slot_to_area_idx/index.html | 2 +- .../bootloader/boot_swap_areas/index.html | 2 +- .../bootloader/boot_vect_delete_main/index.html | 2 +- .../bootloader/boot_vect_delete_test/index.html | 2 +- .../bootloader/boot_vect_read_main/index.html | 2 +- .../bootloader/boot_vect_read_one/index.html | 2 +- .../bootloader/boot_vect_read_test/index.html | 2 +- .../bootloader/boot_write_status/index.html | 2 +- os/modules/bootloader/bootloader/index.html | 2 +- os/modules/console/console/index.html | 2 +- os/modules/console/console_add_char/index.html | 2 +- .../console/console_blocking_mode/index.html | 2 +- .../console/console_blocking_tx/index.html | 2 +- os/modules/console/console_init/index.html | 2 +- os/modules/console/console_printf/index.html | 2 +- os/modules/console/console_pull_char/index.html | 2 +- .../console/console_pull_char_head/index.html | 2 +- .../console/console_queue_char/index.html | 2 +- os/modules/console/console_read/index.html | 2 +- os/modules/console/console_rx_char/index.html | 2 +- os/modules/console/console_tx_char/index.html | 2 +- os/modules/console/console_write/index.html | 2 +- os/modules/elua/elua/index.html | 2 +- os/modules/elua/lua_init/index.html | 2 +- os/modules/elua/lua_main/index.html | 2 +- os/modules/filesystem/index.html | 2 +- os/modules/imgmgr/imgmgr/index.html | 2 +- os/modules/imgmgr/imgmgr_module_init/index.html | 2 +- os/modules/imgmgr/imgr_ver_parse/index.html | 2 +- os/modules/imgmgr/imgr_ver_str/index.html | 2 +- os/modules/json/json/index.html | 2 +- .../json/json_encode_object_entry/index.html | 2 +- .../json/json_encode_object_finish/index.html | 2 +- .../json/json_encode_object_key/index.html | 2 +- .../json/json_encode_object_start/index.html | 2 +- os/modules/json/json_encode_value/index.html | 2 +- .../json/json_internal_read_object/index.html | 2 +- os/modules/json/json_read_array/index.html | 2 +- os/modules/json/json_read_object/index.html | 2 +- os/modules/json/json_target_address/index.html | 2 +- os/modules/nffs/index.html | 2 +- os/modules/shell/shell/index.html | 2 +- os/modules/shell/shell_cmd/index.html | 2 +- os/modules/shell/shell_cmd_list_lock/index.html | 2 +- .../shell/shell_cmd_list_unlock/index.html | 2 +- os/modules/shell/shell_cmd_register/index.html | 2 +- os/modules/shell/shell_console_rx_cb/index.html | 2 +- os/modules/shell/shell_echo_cmd/index.html | 2 +- os/modules/shell/shell_help_cmd/index.html | 2 +- .../shell/shell_nlip_input_register/index.html | 2 +- .../shell/shell_nlip_mqueue_process/index.html | 2 +- os/modules/shell/shell_nlip_mtx/index.html | 2 +- os/modules/shell/shell_nlip_output/index.html | 2 +- os/modules/shell/shell_nlip_process/index.html | 2 +- .../shell/shell_os_mpool_display_cmd/index.html | 2 +- .../shell/shell_os_tasks_display_cmd/index.html | 2 +- .../shell/shell_process_command/index.html | 2 +- os/modules/shell/shell_read_console/index.html | 2 +- os/modules/shell/shell_task_func/index.html | 2 +- os/modules/shell/shell_task_init/index.html | 2 +- os/modules/testutil/testutil/index.html | 2 +- os/modules/testutil/tu_case_abort/index.html | 2 +- .../tu_case_append_assert_msg/index.html | 2 +- .../testutil/tu_case_append_buf/index.html | 2 +- .../tu_case_append_file_info/index.html | 2 +- .../tu_case_append_manual_pass_msg/index.html | 2 +- os/modules/testutil/tu_case_complete/index.html | 2 +- .../testutil/tu_case_fail_assert/index.html | 2 +- os/modules/testutil/tu_case_init/index.html | 2 +- .../testutil/tu_case_pass_manual/index.html | 2 +- os/modules/testutil/tu_case_set_name/index.html | 2 +- .../testutil/tu_case_vappend_buf/index.html | 2 +- .../testutil/tu_case_write_fail_buf/index.html | 2 +- .../testutil/tu_case_write_pass_auto/index.html | 2 +- .../testutil/tu_case_write_pass_buf/index.html | 2 +- os/modules/testutil/tu_init/index.html | 2 +- os/modules/testutil/tu_restart/index.html | 2 +- os/modules/testutil/tu_suite_init/index.html | 2 +- .../testutil/tu_suite_set_name/index.html | 2 +- sitemap.xml | 30 +- 216 files changed, 3791 insertions(+), 267 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/community/index.html ---------------------------------------------------------------------- diff --git a/community/index.html b/community/index.html index 9567ecb..420224b 100644 --- a/community/index.html +++ b/community/index.html @@ -6,7 +6,7 @@ - + Community - Apache Mynewt @@ -235,12 +235,12 @@

Contributing Code

- You get started by submitting patches for your peers to review and merge. After a few patches under your belt you will get access to commit code directly to the module you are working on in the repository. Over time you will get full access to all the repositories and can commit code to any module.

+ You can start contributing right away even if you are not a committer on Apache Mynewt! The proposed workflow is explained here. You essentially submit your edits for your peers to review and merge. After a few patches under your belt you will get access to commit code directly to the module you are working on in the repository. Over time you will get full access to all the repositories and can commit code to any module.

You may choose to submit patches in one of the two following ways:


  1. - Clone the repository into a local branch on your machine and make your changes. Then Submit a pull request on the github mirror of the appropriate Apache Mynewt repository by clicking the green "New pull request" button on the page: + Clone the repository into a local branch on your machine and make your changes. Then submit a pull request on the github mirror of the appropriate Apache Mynewt repository by clicking the green "New pull request" button on the page:

    • Apache Mynewt larva repo mirrored on github
      • @@ -254,7 +254,7 @@

      One or more committers will review your work, ask for edits or clarifications, and merge when it is ready.


    • - Submit your new code snippet along with a diff from the old code via email to the @dev mailing list. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message. + Use the `git format-patch` command to produce a patch file. Submit the patch (your code changes along with a diff from the old code) via email to the @dev mailing list. Summarize the issue and your work in the email. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message.

      • @@ -272,11 +272,14 @@

      Contributing to the web site

      All content on this site is statically generated using MkDocs from documents written in Markdown and HTML and stored on the master branch in the documentation repository.


      -

      Click on the tutorial "How to edit docs" under "Get Started", the first chapter in Docs, to learn how to edit a sample file try_markdown.md on Mynewt's documentation git repository. The static html content for this website 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. +

      Click on the tutorial "Edit docs" under "Tutorials" in the Mynewt Manual to learn how to edit a sample file `try_markdown.md` on Mynewt's documentation git repository. The static html content for this website 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 builtin webserver as described in MkDocs. This step is optional but described in the tutorial.

      +
      +

      If you are not a committer on Apache Mynewt, you cannot push changes to the site repository directly. You will have to work with the mirror on github.com. Go to Apache Mynewt documentation repo mirrored on github to clone the repository into a local branch on your machine. Make your changes. Then submit a pull request on the github mirror repository by clicking the green "New pull request" button on the page. +

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/documentation/index.html ---------------------------------------------------------------------- diff --git a/documentation/index.html b/documentation/index.html index 10cf042..787b1c9 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -6,7 +6,7 @@ - + Documentation - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/download/index.html ---------------------------------------------------------------------- diff --git a/download/index.html b/download/index.html index 0b0e25e..63e9363 100644 --- a/download/index.html +++ b/download/index.html @@ -6,7 +6,7 @@ - + Download - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/events/index.html ---------------------------------------------------------------------- diff --git a/events/index.html b/events/index.html index 028343e..39c2e66 100644 --- a/events/index.html +++ b/events/index.html @@ -6,7 +6,7 @@ - + Events - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index 8ae7572..0bf92d6 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,7 @@ - + Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/mkdocs/search_index.json ---------------------------------------------------------------------- diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json index 7ceef39..4a34336 100644 --- a/mkdocs/search_index.json +++ b/mkdocs/search_index.json @@ -178,7 +178,7 @@ { "location": "/os/get_acclimated/project2/", "text": "Project 2 - Blinky on additional boards\n\n\nObjective\n\n\nThe goal of this tutorial is to download a generic firmware skeleton (\"bootstrap image\") that applies to any hardware and then throw in additional applicable eggs to generate a build for a specific board. In the process you will be exposed to more Mynewt terms and Newt tool commands.\n\n\nThe following target hardware chips are covered:\n\n\n\n\nSTM32F303VC MCU\n from STMicroelectronics\n\n\nnRF52 Series\n from Nordic Semiconductors \n\n\n\n\nSTM32F303VC MCU\n\n\nHardware needed\n\n\n\n\nDiscovery kit with STM32F303VC MCU\n\n\nLaptop running Mac OS\n\n\n\n\nStep by Step Instructions to build image\n\n\n\n\nThe first step is to download the generic skeleton of the project. The eggs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as a nest in a separate repository on Apache. You know it is a nest because there is a nest.yml file. \n\n\n\n\n [user:~/dev ]$ newt nest create test_project\n Downloading nest skeleton from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!\n Nest test_project successfully created in ~/dev/go/test_project\n\n [user:~/dev]$ cd test_project/\n [user:~/dev/test_project]$ ls\n README.md compiler hw libs nest.yml\n\n\n\n\n\n\nNext, the clutch of eggs named larva is added from the nest (also named larva) from another repository on Apache. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (\nclutch.yml\n) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.\n\n\n\n\n [user:~/dev/test_project]$ newt nest add-clutch larva https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git\n Downloading clutch. yml from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!\n Verifying clutch.yml format...\n ok!\n Clutch larva successfully installed to Nest.\n\n\n\n\n\n\nThe next step is to install relevant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. \n\n\n\n\n\n [user:~/dev/test_project]$ newt egg install project/blinky \n Downloading larva from https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!\n Installing project/blinky\n Installing libs/console/full\n Installing libs/shell\n Installation was a success!\n\n [user:~/dev/test_project]$ newt egg install hw/bsp/stm32f3discovery\n Downloading larva from https://git-wip-us.ap ache.org/repos/asf/incubator-mynewt-larva/master... ok!\n Installing hw/bsp/stm32f3discovery\n Installing hw/mcu/stm/stm32f3xx\n Installing libs/cmsis-core\n Installing compiler/arm-none-eabi-m4\n Installation was a success!\n\n\n\n\n\n\nIt's time to create a target for the project and define the target attributes. \n\n\n\n\n [user:~/dev/test_project]$ newt target create blink_f3disc\n Creating target blink_f3disc\n Target blink_f3disc successfully created!\n\n [user:~/dev/test_project]$ newt target set blink_f3disc project=blinky\n Target blink_f3disc successfully set project to blinky\n\n [user:~/dev/test_project]$ newt target set blink_f3disc bsp=hw/bsp/stm32f3discovery\n Target blink_f3disc successfully set bsp to hw/bsp/stm32f3discovery\n\n [user:~/dev/test_project]$ newt target set blink_f3disc compiler_def=debug\n Target blink_f3disc successfully set compiler_def to debug\n\n [user:~/dev/test_project]$ newt target set blink_f3disc compiler=arm-none-eabi-m4\n Target blink_f3disc successfully set compiler to arm-none-eabi-m4\n\n [user:~/dev/test_project]$ newt target set blink_f3disc arch=cortex_m4\n Target blink_f3disc successfully set arch to cortex_m4\n\n [user:~/dev/test_project]$ newt target show blink_f3disc\n blink_f3disc\n arch: cortex_m4\n project: blinky\n bsp: hw/bsp/stm32f3discovery\n compiler_def: debug\n compiler: arm-none-eabi-m4\n name: blink_f3disc\n\n\n\n\n\n\n\n\nNext, you get to build the target and generate an executable that can then be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you w ill find the User Manual at \nhttp://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf\n\n\n\n\n\n\n\n\n\n\n\n\n [user:~/dev/test_project]$ newt target build blink_f3disc\n Building target blink_f3disc (project = blinky)\n Compiling case.c\n Compiling suite.c\n Compiling testutil.c\n Compiling testutil_arch_arm.c\n Archiving libtestutil.a\n Compiling os.c\n Compiling os_callout.c\n Compiling os_eventq.c\n Compiling os_heap.c\n Compiling os_mbuf.c\n Compiling os_mempool.c\n Compiling os_mutex.c\n Compiling os_sanity.c\n Compiling os_sched.c\n Compiling os_sem.c\n Compiling os_task.c\n Compiling os_time.c\n Compiling os_arch_arm.c\n Assembling HAL_CM4.s\n Assembling SVC_Table.s\n Archiving libos.a\n Compiling hal_gpio.c\n Compiling stm32f3xx_hal_gpio.c\n Archiving libstm32f3xx.a\n Compiling cmsis_nvic.c\n Compiling libc_stubs.c\n Compiling os_bsp.c\n Compiling sbrk.c\n Compiling system_stm32f3xx.c\n Assembling startup_stm32f303xc.s\n Archiving libstm32f3discovery.a\n Compiling main.c\n Building project blinky\n Linking blinky.elf\n Successfully run!\n\n\n\n\n\n\nFinally, you have to download the image on to the board. You will see a blue light start to blink.\n\n\n\n\n [user:~/dev/test_project]$ newt target download blink_f3disc\n Downloading with /Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download.sh\n\n\n\n\nnRF52 Series\n\n\nHardware needed\n\n\n\n\nnRF52 Development Kit\n\n\nLaptop running Mac OS\n\n\n\n\nStep by Step Instructions to build image\n\n\n\n\nThe first step is to download the generic skeleton of the project. The eggs installed are not hardware architecture specific.\n\n\n\n\n []user@~/dev]$ newt nest cr eate nordic_blinky\n Downloading nest skeleton from https://www.github.com/mynewt/tadpole... ok!\n Nest nordic_blinky successfully created in ~dev/nordic_blinky\n\n user@~/dev$ cd nordic_blinky/\n\n\n\n\n\n\nThen, the clutch of eggs named larva is added from the nest (also named larva) on the github. This step simply downloads the clutch description file and does not actually install the eggs that constitute the clutch. The clutch description file (\nclutch.yml\n) will be used to check dependencies during the egg install to ensure completeness. It serves as a reference for all the eggs in the clutch that one can choose from and install.\n\n\n\n\n []user@~/dev/nordic_blinky]$ newt nest add-clutch larva https://github.com/mynewt/larva\n Downloading clutch.yml from https://github.com/mynewt/larva/master... ok!\n Verifying clutch.yml format...ok!\n Clutch larva successfully installed to Nest.\n\n\n\n\n\n\nThe next step is to install relev ant eggs from the larva nest on github. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. \n\n\n\n\n [user@~/dev/nordic_blinky]$ newt egg install project/blinky \n Downloading larva from https://github.com/mynewt/larva//master... ok!\n Installing project/blinky\n Installation was a success!\n\n\n [user@~/dev/nordic_blinky]$ newt egg install hw/bsp/nrf52pdk\n Downloading larva from https://github.com/mynewt/larva//master... ok!\n Installing hw/bsp/nrf52pdk\n Installing hw/mcu/nordic/nrf52xxx\n Installing libs/cmsis-core\n Installing compiler/arm-none-eabi-m4\n Installation was a success!\n\n\n\n\n\n\nIt's time to create a target for the project and define the target attributes. \n\n\n\n\n [user@~/dev/nordic_blin ky]$ newt target create blink_nordic\n Creating target blink_nordic\n Target blink_nordic successfully created!\n [user@~/dev/nordic_blinky]$ newt target set blink_nordic project=blinky\n Target blink_nordic successfully set project to blinky\n [user@~/dev/nordic_blinky]$ newt target set blink_nordic bsp=hw/bsp/nrf52pdk\n Target blink_nordic successfully set bsp to hw/bsp/nrf52pdk\n [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler_def=debug\n Target blink_nordic successfully set compiler_def to debug\n [user@~/dev/nordic_blinky]$ newt target set blink_nordic compiler=arm-none-eabi-m4\n Target blink_nordic successfully set compiler to arm-none-eabi-m4\n [user@~/dev/nordic_blinky]$ newt target set blink_nordic arch=cortex_m4\n Target blink_nordic successfully set arch to cortex_m4\n [user@~/dev/nordic_blinky]$ newt target show\n blink_nordic\n compiler: arm-non e-eabi-m4\n name: blink_nordic\n arch: cortex_m4\n project: blinky\n bsp: hw/bsp/nrf52pdk\n compiler_def: debug\n\n\n\n\n\n\nFinally, you get to build the target and generate an executable that can now be uploaded to the board via the on-board SEGGER J-Link debugger. \n\n\n\n\n [user@~/dev/nordic_blinky]$ newt target build blink_nordic\n Building target blink_nordic (project = blinky)\n Compiling case.c\n Compiling suite.c\n Compiling testutil.c\n Compiling testutil_arch_arm.c\n Archiving libtestutil.a\n Compiling os.c\n Compiling os_callout.c\n Compiling os_eventq.c\n Compiling os_heap.c\n Compiling os_mbuf.c\n Compiling os_mempool.c\n Compiling os_mutex.c\n Compiling os_sanity.c\n Compiling os_sched.c\n Compiling os_sem.c\n Compiling os_task.c\n Compiling os_time.c\n Compiling os_arch_arm. c\n Assembling HAL_CM4.s\n Assembling SVC_Table.s\n Archiving libos.a\n Compiling hal_cputime.c\n Compiling hal_gpio.c\n Compiling hal_uart.c\n Archiving libnrf52xxx.a\n Compiling cmsis_nvic.c\n Compiling hal_bsp.c\n Compiling libc_stubs.c\n Compiling os_bsp.c\n Compiling sbrk.c\n Compiling system_nrf52.c\n Assembling gcc_startup_nrf52.s\n Archiving libnrf52pdk.a\n Compiling main.c\n Building project blinky\n Linking blinky.elf\n Successfully run!\n\n\n\n\n\n\n\n\nIn order to be able to communicate with the SEGGER J-Link debugger on the dev board, you have to download and install the J-Link GDB Server software on to your laptop. You may download the \"Software and documentation pack for Mac OS X\" from \nhttps://www.segger.com/jlink-software.html\n. The command line version of the server is used in the steps below. \n\n\n\n\n\n\nOpen a new terminal and start a J-Link session.\n\n\n\n\n\n\n [user@~/dev/nordic_blinky/project/blinky/bin]$ which JLinkGDBServer\n /usr/local/bin/JLinkGDBServer\n [user@~/dev/nordic_blinky/project/blinky/bin]$ JLinkGDBServer -if SWD\n SEGGER J-Link GDB Server V5.02f Command Line Version\n\n JLinkARM.dll V5.02f (DLL compiled Oct 2 2015 20:55:03)\n\n -----GDB Server start settings-----\n GDBInit file: none\n GDB Server Listening port: 2331\n SWO raw output listening port: 2332\n Terminal I/O port: 2333\n Accept remote connection: yes\n Generate logfile: off\n Verify download: off\n Init regs on start: off\n Silent mode: off\n Single run mode: off\n Target connection timeout: 0 ms\n ------J-Link related settings------\n J-Link Host interface: USB\n J- Link script: none\n J-Link settings file: none\n ------Target related settings------\n Target device: unspecified\n Target interface: SWD\n Target interface speed: 1000kHz\n Target endian: little\n\n Connecting to J-Link...\n J-Link is connected.\n Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Aug 28 2015 19:26:24\n Hardware: V1.00\n S/N: 682371959\n Checking target voltage...\n Target voltage: 3.30 V\n Listening on TCP/IP port 2331\n Connecting to target...Connected to target\n Waiting for GDB connection...Connected to 127.0.0.1\n\n\n\n\n\n\nYou need a configuration file for the GDB session to be opened correctly and the image (\"blinky.elf\") you built for this target downloaded to flash. A sample config script is given below. Alternatively, you could choose to type each command at the gdb prompt.\n\n\n\n\n [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ cat jlink-gdb.cfg \n echo ***Setting up the environment for debugging gdb.***\\n\n set complaints 1\n set prompt (gdb) \n set endian little\n echo \\n*** Set target charset ASCII\\n\n set target-charset ASCII\n echo \\n*** Connecting over port #2331 ***\\n\n target remote localhost:2331\n echo \\n*** Enable flash write and set device to nrf52 ***\\n\n monitor flash download=1\n monitor flash device=nRF52\n echo \\n*** loading blinky.elf ***\\n\n load ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf \n symbol-file ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf\n echo \\n*** Resetting target ***\\n\n monitor reset\n echo \\n*** Halting target ***\\n\n monitor halt\n\n\n\n\n\n\nStart the gdb session and monitor that it loads the image, resets the target, and halts for a command to continue. \n\n\n\n\n [user@~/dev/nordic_blinky/project/blinky/bin/blink_nordic]$ arm-none-eabi-gdb -x ~/dev/nordic_blinky/project/blinky/bin/blink_nordic/jlink-gdb.cfg\n\n GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs\n Copyright (C) 2014 Free Software Foundation, Inc.\n License GPLv3+: GNU GPL version 3 or later \nhttp://gnu.org/licenses/gpl.html\n\n This is free software: you are free to change and redistribute it.\n There is NO WARRANTY, to the extent permitted by law. Type \nshow copying\n\n and \nshow warranty\n for details.\n This GDB was configured as \n--host=x86_64-apple-darwin10 --target=arm-none-eabi\n.\n Type \nshow configuration\n for configuration details.\n For bug reporting instructions, please see:\n \nhttp://www.gnu.org/software/gdb/bugs/\n.\n Find the GDB manual and other documentation resources online at:\n \nhttp://www.gnu.org/software/gdb/documentation/\n.\n For help, type \nhelp\n.\n Type \napropos word\n to search for commands related to \nword\n.\n\n ***Setting up the environment for debugging gdb.***\n The target is assumed to be little endian\n\n *** Set target charset ASCII\n\n *** Connecting over port #2331 ***\n 0x00003c34 in ?? ()\n\n *** Enable flash write and set device to nrf52 ***\n Flash download enabled\n Selecting device: nRF52\n\n *** loading blinky.elf ***\n Loading section .text, size 0x5c84 lma 0x0\n Loading section .ARM.extab, size 0x24 lma 0x5c84\n Loading section .ARM.exidx, size 0xd8 lma 0x5ca8\n Loading section .data, size 0x8f8 lma 0x5d80\n Start address 0x48c, load size 26232\n Transfer rate: 12808 KB/sec, 2914 bytes/write.\n During symbol reading, unexpected overlap between:\n (A) section `.text' from `~/dev/nordic_b linky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x5c84)\n (B) section `*COM*' from `~/dev/nordic_blinky/project/blinky/bin/blink_nordic/blinky.elf' [0x0, 0x0).\n Will ignore section B.\n\n *** Resetting target ***\n Resetting target\n\n *** Halting target ***\n\n\n\n\n\n\nType 'c' to continue. The LED on the board will start to blink. You will also see some activity in the terminal showing the open J-Link GDB server connection. The LED will continue to blink after you quit out of that connection.\n\n\n\n\n (gdb) c\n Continuing.", - "title": "Blinky on Real Hardware" + "title": "Blinky on More Boards" }, { "location": "/os/get_acclimated/project2/#project-2-blinky-on-additional-boards", @@ -231,6 +231,71 @@ "title": "How to Test an Egg" }, { + "location": "/os/get_acclimated/how_to_edit_docs/", + "text": "How to Edit Docs\n\n\nObjective\n\n\nLearn the process of editing docs by adding some content to a test document.\n\n\nMarkdown, MkDocs, Mou\n\n\nThe Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at \nhttp://www.mkdocs.org\n. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).\n\n\nYou do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as \nMou\n is enough to check how it will look after the doc ument has gone through MkDocs. Go ahead and download \nMou\n. If you are on a Windows machine, download the \neditor of your choice\n.\n\n\nCurrently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.\n\n\nAccess to the Apache repo\n\n\nGet an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.\n\n\nIf you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is \nhttps://git-wip-us.apache.org/docs/workflow.html\n. You will find the steps described in more detail later in this tutorial.\n\n\nMaking a local copy\n\n\n\n\nCopy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committ er.\n\n\n\n\n $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git\n Cloning into 'incubator-mynewt-site'...\n remote: Counting objects: 330, done.\n remote: Compressing objects: 100% (263/263), done.\n remote: Total 330 (delta 120), reused 0 (delta 0)\n Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.\n Resolving deltas: 100% (120/120), done.\n Checking connectivity... done.\n $ ls\n incubator-mynewt-site\n $ ls incubator-mynewt-site/\n docs images mkdocs.yml\n\n\n\n\n\n\nCreate a new branch to work on your documentation and move to that branch.\n\n\n\n\n $ git checkout -b \nyour-branch-name\n\n\n\n\n\nFile to be edited\n\n\nThe file you will edit is named try_markdown.md. It is in the incubator-mynewt-site/docs/os/get_acclimated/ directory.\n\n\nEditing an existing page\n\n\n\n\n\n\nOpen the application Mou.\n\n\n\n\n\n\nOpen the file inc ubator-mynewt-site/docs/os/get_acclimated/try_markdown.md in Mou.\n\n\n\n\n\n\nEdit the last item on the list.\n\n\n\n\n\n\nSave and quit the application.\n\n\n\n\n\n\nAdding a new page\n\n\nIf you create a new file somewhere in the \ndocs\n subdirectory to add a new page, you have to add a line in the \nmkdocs.yml\n file at the correct level. For example, if you add a new module named \"Ethernet\" by creating a new file named \nethernet.md\n in the \nmodules\n subdirectory, you have to insert the following line under \nModules:\n in the \nmkdocs.yml\n file.\n\n\n - 'Ethernet': 'modules/ethernet.md'\n\n\n\n\nPushing changes to remote as a committer\n\n\nIf you are not a committer yet, skip this section and proceed to the \nnext section\n.\n\n\n\n\nCheck whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.\n\n\n\n\n $ git remote -v\n origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt -site.git (fetch)\n origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)\n\n\n\n\n\n\nIf, however, you do not see your remote repository, then set it up as follows.\n\n\n\n\n $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git \n\n\n\n\n\n\nFirst check the git status. It will show you that the \ntry_markdown.md\n document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. \n\n\n\n\nDuring staging below using \ngit add\n, we use the \n-A\n option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after \n-m\n) should summarize what your changes are about.\n\n\n $ git status\n $ git add -A \n $ git commit -m \nMy first doc change as a trial run\n\n $ git push -u origin \nyour-branch-name\n\n\n\n\n \n\n\n\n\nYou can see the changed Markdown file if you traverse the tree on the git repository \n https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git\n.\n\n\n\n\n\n\nA commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The \"upstream\" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.\n\n\n\n\n\n\nSharing changes as a non-committer\n\n\nWe suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is \nhttps://git-wip-us.apache.org/docs/workflow.html\n. \n\n\n\n\nAssuming you have made changes to the example file, you will first commit your changes.\n\n\n\n\n $ git add -A \n $ git commit -m \nMy first doc change as a trial run\n\n\n\n\n\n\n\nOnce you're ready to share your changes with the rest of the project team, you can use the git format-patc h command to produce a patch file (or a nice set of patches in the future) and email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough.\n\n\n\n\nIf there is a JIRA ticket associated with your work you should post your patch files to the ticket.\n\n\n $ git format-patch origin/trunk\n\n\n\n\n\n\nAlternatively, you can use the mirror on github.com to submit a pull request. The mirror is located at \nhttps://github.com/apache/incubator-mynewt-site\n. It is up to you to decide whether to create a fork or a branch to work in and submit pull requests from. Your pull request will be reviewed by a committer for docs and merged into the master branch when the changes are understood and accepted. \n\n\n\n\nConversion to HTML\n\n\nThe conversion of the Markdown fil es to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.\n\n\nLocal preview of HTML files\n\n\nHowever, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).\n\n\n $ python --version\n Python 2.7.2\n $ pip --version\n pip 1.5.2\n $ pip install mkdocs\n\n\n\n\nYou will then run the built-in webserver from the root of the documentation directory using the command \nmkdocs serve\n. The root directory for documentation is \nincubator-my newt-site\n or the directory with the \nmkdocs.yml\n file.\n\n\n $ ls\n docs images mkdocs.yml\n $ mkdocs serve\n\n\n\n\nThen go to \nhttp://127.0.0.1:8000\n to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.\n\n\nFor more information on MkDocs go to \nhttp://www.mkdocs.org\n.", + "title": "Edit Docs" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#how-to-edit-docs", + "text": "", + "title": "How to Edit Docs" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#objective", + "text": "Learn the process of editing docs by adding some content to a test document.", + "title": "Objective" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#markdown-mkdocs-mou", + "text": "The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at http://www.mkdocs.org . Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs). You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as Mou is enough to check how it will look after the document has gone through MkDocs. Go ahead and download Mou . If you are on a Windows machine, download the editor of your choice . Currently someone in t he project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.", + "title": "Markdown, MkDocs, Mou" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#access-to-the-apache-repo", + "text": "Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it. If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html . You will find the steps described in more detail later in this tutorial.", + "title": "Access to the Apache repo" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#making-a-local-copy", + "text": "Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer. $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git\n Cloning into 'incubator-mynewt-site'...\n remote: Counting objects: 330, done.\n remote: Compressing objects: 100% (263/263), done.\n remote: Total 330 (delta 120), reused 0 (delta 0)\n Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.\n Resolving deltas: 100% (120/120), done.\n Checking connectivity... done.\n $ ls\n incubator-mynewt-site\n $ ls incubator-mynewt-site/\n docs images mkdocs.yml Create a new branch to work on your documentation and move to that branch. $ git checkout -b your-branch-name", + "title": "Making a local copy" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#file-to-be-edited", + "text": "The file you will edit is named try_markdown.md. It is in the incubator-mynewt-site/docs/os/get_acclimated/ directory.", + "title": "File to be edited" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#editing-an-existing-page", + "text": "Open the application Mou. Open the file incubator-mynewt-site/docs/os/get_acclimated/try_markdown.md in Mou. Edit the last item on the list. Save and quit the application.", + "title": "Editing an existing page" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#adding-a-new-page", + "text": "If you create a new file somewhere in the docs subdirectory to add a new page, you have to add a line in the mkdocs.yml file at the correct level. For example, if you add a new module named \"Ethernet\" by creating a new file named ethernet.md in the modules subdirectory, you have to insert the following line under Modules: in the mkdocs.yml file. - 'Ethernet': 'modules/ethernet.md'", + "title": "Adding a new page" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#pushing-changes-to-remote-as-a-committer", + "text": "If you are not a committer yet, skip this section and proceed to the next section . Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step. $ git remote -v\n origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)\n origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push) If, however, you do not see your remote repository, then set it up as follows. $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git First check the git status. It will show you that the try_markdown.md document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. During staging below using git add , we use the -A option indicating you want to stage all your modifications. Instead, you can choose to specify onl y the files that you want to. The commit message (specified after -m ) should summarize what your changes are about. $ git status\n $ git add -A \n $ git commit -m My first doc change as a trial run \n $ git push -u origin your-branch-name You can see the changed Markdown file if you traverse the tree on the git repository https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git . A commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The \"upstream\" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.", + "title": "Pushing changes to remote as a committer" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#sharing-changes-as-a-non-committer", + "text": "We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is https://git-wip-us.apache.org/docs/workflow.html . Assuming you have made changes to the example file, you will first commit your changes. $ git add -A \n $ git commit -m My first doc change as a trial run Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future) and email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough. If there is a JIRA ticket associated with your work you should post your patch files to the ticket. $ git format-patch origin/trunk Alternatively, you can use the mirror on github.com to submit a pull request. The mirror is located at https://github.com/apache/incubator-mynewt-site . It is up to you to decide whether to create a fork or a branch to work in and submit pull requests from. Your pull request will be reviewed by a committer for docs and merged into the master branch when the changes are understood and accepted.", + "title": "Sharing changes as a non-committer" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#conversion-to-html", + "text": "The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.", + "title": "Conversion to HTML" + }, + { + "location": "/os/get_acclimated/how_to_edit_docs/#local-preview-of-html-files", + "text": "However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will). $ python --version\n Python 2.7.2\n $ pip --version\n pip 1.5.2\n $ pip install mkdocs You will then run the built-in webserver from the root of the documentation directory using the command mkdocs serve . The root directory for documentation is incubator-mynewt-site or the directory with the mkdocs.yml file. $ ls\n docs images mkdocs.yml\n $ mkdocs serve Then go to http://127.0.0.1:8000 to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be upd ated. For more information on MkDocs go to http://www.mkdocs.org .", + "title": "Local preview of HTML files" + }, + { "location": "/os/core_os/mynewt_os/", "text": "Mynewt OS\n\n\nInsert introduction here \n\n\nReal-Time Kernel \n\n\nDescription\n\n\nReal-Time OS \n\n\nDescription\n\n\nInsert topic of your choice\n\n\nDescription\n\n\nFeatures\n\n\n\n\n\n\nScheduler/context switching\n\n\nTime\n\n\nTasks\n\n\nEvent queues/callouts\n\n\nSemaphores\n\n\nMutexes\n\n\nMemory pools\n\n\nHeap\n\n\nMbufs\n\n\nSanity\n\n\nPorting OS to other platforms\n\n\n\n\nOS Functions\n\n\nThe functions available at the OS level are:\n\n\n\n\nos_init\n\n\nos_start\n\n\nos_started", "title": "Overview" @@ -421,6 +486,11 @@ "title": "List of Functions" }, { + "location": "/os/core_os/task/_clear_stack/", + "text": "", + "title": "_clear_stack" + }, + { "location": "/os/core_os/task/os_task_count/", "text": "", "title": "os_task_count" @@ -436,6 +506,11 @@ "title": "os_task_init" }, { + "location": "/os/core_os/task/os_task_next_id/", + "text": "", + "title": "os_task_next_id" + }, + { "location": "/os/core_os/task/os_task_sanity_checkin/", "text": "", "title": "os_task_sanity_checkin" @@ -1176,6 +1251,16 @@ "title": "List of Functions" }, { + "location": "/os/core_os/mbuf/_os_mbuf_copypkthdr/", + "text": "", + "title": "_os_mbuf_copypkthdr" + }, + { + "location": "/os/core_os/mbuf/_os_msys_find_pool/", + "text": "", + "title": "_os_msys_find_pool.md" + }, + { "location": "/os/core_os/mbuf/os_mbuf_adj/", "text": "", "title": "os_mbuf_adj" http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_app/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_app/index.html b/newt/command_list/newt_app/index.html index a79a4ba..8048dd0 100644 --- a/newt/command_list/newt_app/index.html +++ b/newt/command_list/newt_app/index.html @@ -6,7 +6,7 @@ - + newt app - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_help/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_help/index.html b/newt/command_list/newt_help/index.html index 4fbd287..1b6ae07 100644 --- a/newt/command_list/newt_help/index.html +++ b/newt/command_list/newt_help/index.html @@ -6,7 +6,7 @@ - + newt help - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_new/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_new/index.html b/newt/command_list/newt_new/index.html index 187a40c..7079dbd 100644 --- a/newt/command_list/newt_new/index.html +++ b/newt/command_list/newt_new/index.html @@ -6,7 +6,7 @@ - + newt new - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_pkg/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_pkg/index.html b/newt/command_list/newt_pkg/index.html index 1757cd2..cd5c716 100644 --- a/newt/command_list/newt_pkg/index.html +++ b/newt/command_list/newt_pkg/index.html @@ -6,7 +6,7 @@ - + newt pkg - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_target/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_target/index.html b/newt/command_list/newt_target/index.html index 2f49d6d..b402679 100644 --- a/newt/command_list/newt_target/index.html +++ b/newt/command_list/newt_target/index.html @@ -6,7 +6,7 @@ - + newt target - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/command_list/newt_version/index.html ---------------------------------------------------------------------- diff --git a/newt/command_list/newt_version/index.html b/newt/command_list/newt_version/index.html index 2ac3868..550c321 100644 --- a/newt/command_list/newt_version/index.html +++ b/newt/command_list/newt_version/index.html @@ -6,7 +6,7 @@ - + newt version - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/newt_intro/index.html ---------------------------------------------------------------------- diff --git a/newt/newt_intro/index.html b/newt/newt_intro/index.html index befb219..ea0c37e 100644 --- a/newt/newt_intro/index.html +++ b/newt/newt_intro/index.html @@ -6,7 +6,7 @@ - + Introduction - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/newt_linux/index.html ---------------------------------------------------------------------- diff --git a/newt/newt_linux/index.html b/newt/newt_linux/index.html index 1f1c450..3e184ba 100644 --- a/newt/newt_linux/index.html +++ b/newt/newt_linux/index.html @@ -6,7 +6,7 @@ - + Install newt from source on Linux - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/newt_mac/index.html ---------------------------------------------------------------------- diff --git a/newt/newt_mac/index.html b/newt/newt_mac/index.html index 6a1903a..4dfaeb1 100644 --- a/newt/newt_mac/index.html +++ b/newt/newt_mac/index.html @@ -6,7 +6,7 @@ - + Install newt from source on Mac - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/newt_ops/index.html ---------------------------------------------------------------------- diff --git a/newt/newt_ops/index.html b/newt/newt_ops/index.html index 9acab02..42b91a3 100644 --- a/newt/newt_ops/index.html +++ b/newt/newt_ops/index.html @@ -6,7 +6,7 @@ - + Command structure - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newt/packaging/dist/index.html ---------------------------------------------------------------------- diff --git a/newt/packaging/dist/index.html b/newt/packaging/dist/index.html index 3f45eba..e7d0fb9 100644 --- a/newt/packaging/dist/index.html +++ b/newt/packaging/dist/index.html @@ -6,7 +6,7 @@ - + Creating Packages - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newtmgr/overview/index.html ---------------------------------------------------------------------- diff --git a/newtmgr/overview/index.html b/newtmgr/overview/index.html index affecd1..f498541 100644 --- a/newtmgr/overview/index.html +++ b/newtmgr/overview/index.html @@ -6,7 +6,7 @@ - + Introduction - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newtmgr/project-slinky/index.html ---------------------------------------------------------------------- diff --git a/newtmgr/project-slinky/index.html b/newtmgr/project-slinky/index.html index 31d577a..39801a4 100644 --- a/newtmgr/project-slinky/index.html +++ b/newtmgr/project-slinky/index.html @@ -6,7 +6,7 @@ - + Project Slinky - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/newtmgr/protocol/index.html ---------------------------------------------------------------------- diff --git a/newtmgr/protocol/index.html b/newtmgr/protocol/index.html index 555242b..5597efb 100644 --- a/newtmgr/protocol/index.html +++ b/newtmgr/protocol/index.html @@ -6,7 +6,7 @@ - + Protocol - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/callout/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/callout/index.html b/os/core_os/callout/callout/index.html index a52d2a4..8496ab5 100644 --- a/os/core_os/callout/callout/index.html +++ b/os/core_os/callout/callout/index.html @@ -6,7 +6,7 @@ - + Overview - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/os_callout_func_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/os_callout_func_init/index.html b/os/core_os/callout/os_callout_func_init/index.html index b83dee1..c00f10e 100644 --- a/os/core_os/callout/os_callout_func_init/index.html +++ b/os/core_os/callout/os_callout_func_init/index.html @@ -6,7 +6,7 @@ - + os_callout_func_init - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/os_callout_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/os_callout_init/index.html b/os/core_os/callout/os_callout_init/index.html index f1701b6..d93650d 100644 --- a/os/core_os/callout/os_callout_init/index.html +++ b/os/core_os/callout/os_callout_init/index.html @@ -6,7 +6,7 @@ - + os_callout_init - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/os_callout_queued/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/os_callout_queued/index.html b/os/core_os/callout/os_callout_queued/index.html index 92bfe7b..7e2c2a9 100644 --- a/os/core_os/callout/os_callout_queued/index.html +++ b/os/core_os/callout/os_callout_queued/index.html @@ -6,7 +6,7 @@ - + os_callout_queued - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/os_callout_reset/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/os_callout_reset/index.html b/os/core_os/callout/os_callout_reset/index.html index bea8929..b0c6fdf 100644 --- a/os/core_os/callout/os_callout_reset/index.html +++ b/os/core_os/callout/os_callout_reset/index.html @@ -6,7 +6,7 @@ - + os_callout_reset - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/callout/os_callout_stop/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/callout/os_callout_stop/index.html b/os/core_os/callout/os_callout_stop/index.html index 71e9d7e..f24ab22 100644 --- a/os/core_os/callout/os_callout_stop/index.html +++ b/os/core_os/callout/os_callout_stop/index.html @@ -6,7 +6,7 @@ - + os_callout_stop - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/context_switch/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/context_switch/index.html b/os/core_os/context_switch/context_switch/index.html index 1ed25f7..0c78f26 100644 --- a/os/core_os/context_switch/context_switch/index.html +++ b/os/core_os/context_switch/context_switch/index.html @@ -6,7 +6,7 @@ - + Overview - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched/index.html b/os/core_os/context_switch/os_sched/index.html index 47ecc09..31fdd0c 100644 --- a/os/core_os/context_switch/os_sched/index.html +++ b/os/core_os/context_switch/os_sched/index.html @@ -6,7 +6,7 @@ - + os_sched - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html b/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html index f1982fd..deaa2e0 100644 --- a/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html +++ b/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html @@ -6,7 +6,7 @@ - + os_sched_ctx_sw_hook - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_get_current_task/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_get_current_task/index.html b/os/core_os/context_switch/os_sched_get_current_task/index.html index 0aa44d9..119a985 100644 --- a/os/core_os/context_switch/os_sched_get_current_task/index.html +++ b/os/core_os/context_switch/os_sched_get_current_task/index.html @@ -6,7 +6,7 @@ - + os_sched_get_current_task - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_insert/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_insert/index.html b/os/core_os/context_switch/os_sched_insert/index.html index 4464485..2688c11 100644 --- a/os/core_os/context_switch/os_sched_insert/index.html +++ b/os/core_os/context_switch/os_sched_insert/index.html @@ -6,7 +6,7 @@ - + os_sched_insert - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_next_task/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_next_task/index.html b/os/core_os/context_switch/os_sched_next_task/index.html index 8e796b9..f7c0203 100644 --- a/os/core_os/context_switch/os_sched_next_task/index.html +++ b/os/core_os/context_switch/os_sched_next_task/index.html @@ -6,7 +6,7 @@ - + os_sched_next_task - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_os_timer_exp/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_os_timer_exp/index.html b/os/core_os/context_switch/os_sched_os_timer_exp/index.html index 13bb7b9..3cb2d21 100644 --- a/os/core_os/context_switch/os_sched_os_timer_exp/index.html +++ b/os/core_os/context_switch/os_sched_os_timer_exp/index.html @@ -6,7 +6,7 @@ - + os_sched_os_timer_exp - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_resort/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_resort/index.html b/os/core_os/context_switch/os_sched_resort/index.html index 98a1c6b..ac35faf 100644 --- a/os/core_os/context_switch/os_sched_resort/index.html +++ b/os/core_os/context_switch/os_sched_resort/index.html @@ -6,7 +6,7 @@ - + os_sched_resort - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_set_current_task/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_set_current_task/index.html b/os/core_os/context_switch/os_sched_set_current_task/index.html index 0ee97c1..69cda6d 100644 --- a/os/core_os/context_switch/os_sched_set_current_task/index.html +++ b/os/core_os/context_switch/os_sched_set_current_task/index.html @@ -6,7 +6,7 @@ - + os_sched_set_current_task - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_sleep/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_sleep/index.html b/os/core_os/context_switch/os_sched_sleep/index.html index b81f708..9992099 100644 --- a/os/core_os/context_switch/os_sched_sleep/index.html +++ b/os/core_os/context_switch/os_sched_sleep/index.html @@ -6,7 +6,7 @@ - + os_sched_sleep - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/context_switch/os_sched_wakeup/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/context_switch/os_sched_wakeup/index.html b/os/core_os/context_switch/os_sched_wakeup/index.html index bc6663b..ee574cc 100644 --- a/os/core_os/context_switch/os_sched_wakeup/index.html +++ b/os/core_os/context_switch/os_sched_wakeup/index.html @@ -6,7 +6,7 @@ - + os_sched_wakeup - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/event_queue/event_queue/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/event_queue/event_queue/index.html b/os/core_os/event_queue/event_queue/index.html index 49e53d1..aec53ba 100644 --- a/os/core_os/event_queue/event_queue/index.html +++ b/os/core_os/event_queue/event_queue/index.html @@ -6,7 +6,7 @@ - + Overview - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/event_queue/os_eventq_get/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/event_queue/os_eventq_get/index.html b/os/core_os/event_queue/os_eventq_get/index.html index 8d5749e..7578140 100644 --- a/os/core_os/event_queue/os_eventq_get/index.html +++ b/os/core_os/event_queue/os_eventq_get/index.html @@ -6,7 +6,7 @@ - + os_eventq_get - Apache Mynewt http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/27438146/os/core_os/event_queue/os_eventq_init/index.html ---------------------------------------------------------------------- diff --git a/os/core_os/event_queue/os_eventq_init/index.html b/os/core_os/event_queue/os_eventq_init/index.html index 17a467a..a20894c 100644 --- a/os/core_os/event_queue/os_eventq_init/index.html +++ b/os/core_os/event_queue/os_eventq_init/index.html @@ -6,7 +6,7 @@ - + os_eventq_init - Apache Mynewt