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 2016/11/15 19:34:38 UTC
[30/40] incubator-mynewt-site git commit: Updated Repos tutorial
Updated Repos tutorial
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/b1afc81a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/b1afc81a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/b1afc81a
Branch: refs/heads/master
Commit: b1afc81a077f8ab40b9437aea562e87fade0677d
Parents: ed14270
Author: David G. Simmons <sa...@mac.com>
Authored: Mon Nov 14 13:35:44 2016 -0500
Committer: David G. Simmons <sa...@mac.com>
Committed: Mon Nov 14 13:35:44 2016 -0500
----------------------------------------------------------------------
docs/index.md | 5 +++-
docs/os/tutorials/repo/add_repos.md | 14 +++++++---
docs/os/tutorials/repo/create_repo.md | 40 ++++++++++++++++++++---------
docs/os/tutorials/repo/upgrade_repo.md | 4 +++
mkdocs.yml | 3 +--
5 files changed, 47 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1afc81a/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index bc1906c..0c9732e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,4 @@
-Apache Mynewt is a real-time, modular operating system for connected IoT devices that need to operate for long periods of time under power, memory, and storage constraints. The first connectivity stack offered is BLE 4.2.
+Apache Mynewt is a real-time, modular operating system for
+connected IoT devices that need to operate for long periods
+of time under power, memory, and storage constraints. The
+first connectivity stack offered is BLE 4.2.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1afc81a/docs/os/tutorials/repo/add_repos.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/repo/add_repos.md b/docs/os/tutorials/repo/add_repos.md
index 22098fa..e280c8e 100644
--- a/docs/os/tutorials/repo/add_repos.md
+++ b/docs/os/tutorials/repo/add_repos.md
@@ -105,7 +105,7 @@ after `github.com` in the repo path. Consider the repository
* **repo** -- The name of the repo. On github, this is the name after
the username described above. Consider the repository
-`https://github.com/apache/incubator-mynewt-core`. It has username
+`https://github.com/apache/incubator-mynewt-core`. It has path
`incubator-mynewt-core`. This is a path to the source control
and should not be confused with the name of the repo that you used in the
`repository.<name>` declaration above. That name is contained elsewhere
@@ -182,9 +182,15 @@ Here is the `repository.yml` file from the apache-Mynewt-core:
```no-highlight
repo.name: apache-mynewt-core
repo.versions:
- "0.7.9": "Mynewt_0_8_0_b2_tag"
- "0-latest": "0.7.9"
- "0.8-latest": "0.7.9"
+ "0.0.0": "develop"
+ "0.7.9": "mynewt_0_8_0_b2_tag"
+ "0.8.0": "mynewt_0_8_0_tag"
+ "0.9.0": "mynewt_0_9_0_tag"
+ "0.9.1": "master"
+ "0-latest": "0.9.0"
+ "0-dev": "0.9.1"
+ "0.8-latest": "0.8.0"
+ "0.9-latest": "0.9.0"
```
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1afc81a/docs/os/tutorials/repo/create_repo.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/repo/create_repo.md b/docs/os/tutorials/repo/create_repo.md
index 1e1927e..63ade07 100644
--- a/docs/os/tutorials/repo/create_repo.md
+++ b/docs/os/tutorials/repo/create_repo.md
@@ -1,10 +1,19 @@
## Create a Repo out of a Project
-In order to create a repository out of a project, all you need to do is create a `repository.yml` file, and check it into the master branch of your project.
+In order to create a repository out of a project, all you need to do is create a
+`repository.yml` file, and check it into the master branch of your project.
-**NOTE:** Currently only github source control service is supported by our package management system, but support for plain git will be added soon.
+**NOTE:** Currently only github source control service is supported by our
+package management system, but support for plain git is planned for a future
+version.
-The repository.yml defines all versions of the repository and the corresponding source control tags that these versions correspond to. As an example, if the repository.yml file has the following content, it means there is one version of the apache-mynewt-core operating system available, which is `0.0.0` (implying we haven't released yet!). Such a version number corresponds to the "develop" branch in this repository. `0-latest` would also resolved to this same `0.0.0` version. The next section explains the versioning system a bit more.
+The `repository.yml` defines all versions of the repository and the corresponding
+source control tags that these versions correspond to. As an example, if the
+`repository.yml` file has the following content, it means there is one version
+of the apache-mynewt-core operating system available, which is `0.0.0` (implying we
+haven't released yet!). Such a version number corresponds to the "develop" branch
+in this repository. `0-latest` would also resolved to this same `0.0.0` version.
+The next section explains the versioning system a bit more.
```
$ more repository.yml
@@ -39,7 +48,8 @@ repo.versions:
It contains the following:
* **repo.name** The external name that is used to include the library in
-your `project.yml` file. This is the name you in include in the `project.repositories` variable when adding this repository to your project.
+your `project.yml` file. This is the name you in include in the `project.repositories`
+variable when adding this repository to your project.
* **repo.versions** A description of what versions to give the user depending
on the settings in their `project.yml` file. See below for a thorough description
on versioning. Its a flexible mapping between version numbers and git branches.
@@ -70,9 +80,9 @@ or
The stability string can be one of 3 pre-defined stability values.
-1. stable -- A stable release version of the repository
-2. dev -- A development version from the repository
-3. latest -- The latest from the repository
+1. `stable` -- A stable release version of the repository
+2. `dev` -- A development version from the repository
+3. `latest` -- The latest from the repository
In your `project.yml` file you can specify different combinations of
the version number and stability value. For example:
@@ -95,7 +105,9 @@ You **cannot** specify a stability string with a fully numbered version, e.g.
A `repository.yml` file contains information to match this version request
into a git branch to fetch for your project.
-It's up to you as the repository maintainer to map these to actual github branches of the repository. For example, let's say in a fictitious repository the following are defined.
+It's up to you as the repository maintainer to map these to actual github branches
+of the repository. For example, let's say in a fictitious repository the
+following are defined.
```no-highlight
repo.versions:
@@ -115,7 +127,8 @@ repo.versions:
```
When the `project.yml` file asks for `1.2-stable` it will be resolved to version
-`1.2.0` which in turn will resolve to a specific branch `xxx_branch_1_2_0`. This is the branch that `newt` will fetch into the project with that `project.yml` file.
+`1.2.0` which in turn will resolve to a specific branch `xxx_branch_1_2_0`.
+This is the branch that `newt` will then fetch into the project with that `project.yml` file.
<br>
@@ -140,13 +153,16 @@ develop.repositories:
This would tell Newt that for anything that resolves to the develop
branch, this repository requires the sterlys-little-repo repository.
-Dependencies are resolved circularly by the newt tool, and every dependent repository is placed as a sibling in the repos directory. Currently, if two repositories have the same name, they will conflict and bad things will happen.
+Dependencies are resolved circularly by the newt tool, and every
+dependent repository is placed as a sibling in the repos directory.
+Currently, if two repositories have the same name, they will conflict
+and bad things will happen.
When a repository is installed to the repos/ directory, the current
-version of that repository is written to the "project.state" file. The
+version of that repository is written to the `project.state` file. The
project state file contains the currently installed version of any given
repository. This way, the current set of repositories can be recreated
-from the project.state file reliably, whereas the project.yml file can
+from the `project.state` file reliably, whereas the `project.yml` file can
have higher level directives (i.e. include 0.8-stable.)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1afc81a/docs/os/tutorials/repo/upgrade_repo.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/repo/upgrade_repo.md b/docs/os/tutorials/repo/upgrade_repo.md
index c44fab8..475535a 100644
--- a/docs/os/tutorials/repo/upgrade_repo.md
+++ b/docs/os/tutorials/repo/upgrade_repo.md
@@ -12,3 +12,7 @@ Newt upgrade will look at the current desired version in `project.yml`,
and compare it to the version in `project.state`. If these two differ, it
will upgrade the dependency. Upgrade works not just for the dependency
in `project.yml`, but for all the sub-dependencies that they might have.
+
+If you have changed any settings in the `project.yml` file, you should run
+`newt upgrade` to ensure that your repos are all up to date with the versions
+specified in your `project.yml` file.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1afc81a/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index f39ac4c..02bca04 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -37,8 +37,7 @@ pages:
- toc: 'os/tutorials/repo/add_repos.md'
- 'Upgrade a repo': 'os/tutorials/repo/upgrade_repo.md'
- 'Turn project into a repo': 'os/tutorials/repo/create_repo.md'
- - 'A Sample Lesson':
- - 'Lesson Unit on Tasks and Priority Management': 'os/tutorials/tasks_lesson.md'
+ - 'Tasks and Priority Management': 'os/tutorials/tasks_lesson.md'
- 'Enable Wi-Fi on Arduino Zero': 'os/tutorials/wi-fi_on_arduino.md'
- 'Write a Test Suite for a Package': 'os/tutorials/unit_test.md'
- 'Air-quality Sensor project': 'os/tutorials/air_quality_sensor.md'