Improve documentation (0.9.10) #379

screamerbg · 2016-10-19T14:29:52Z

Add documentation for publishing local/new repositories "mbed publish" sends to a 404 in case the project is not Git-enabled #362
Add documentation regarding the specific Python, Git and Mercurial versions that mbed CLI supports mbed-cli does not support Python3 #376

Reviewers:

iriark01 · 2016-10-19T14:30:52Z

README.md

@@ -691,6 +691,22 @@ As with any mbed CLI command, `mbed update` uses the current directory as a work

 <span class="tips">**Tip: Synchronizing library references:** Before triggering an update, you might want to synchronize any changes that you've made to the program structure by running ``mbed sync``, which will update the necessary library references and get rid of the invalid ones.</span>

+## Publishing local program or library


Publishing a local program or library

iriark01 · 2016-10-19T14:31:51Z

README.md

@@ -691,6 +691,22 @@ As with any mbed CLI command, `mbed update` uses the current directory as a work

 <span class="tips">**Tip: Synchronizing library references:** Before triggering an update, you might want to synchronize any changes that you've made to the program structure by running ``mbed sync``, which will update the necessary library references and get rid of the invalid ones.</span>

+## Publishing local program or library
+
+When you create new (local) source control managed program or library, all revision history will exist only locally and the repository wouldn't be associated with remote one. To publish the local repository (while preserving the revision history) please follow these steps:


When you create a new (local) source-control managed program or library, its revision history exists only locally; the repository is not associated with the remote one. To publish the local repository without losing its revision history, please follow these steps:

iriark01 · 2016-10-19T14:32:47Z

README.md

+## Publishing local program or library
+
+When you create new (local) source control managed program or library, all revision history will exist only locally and the repository wouldn't be associated with remote one. To publish the local repository (while preserving the revision history) please follow these steps:
+1. Create new empty repository on the remote side - either based on public repository hosting service (Github, Bitbucket, mbed.org), service of your own or even different location on your system


Create a new empty repository on the remote site. This can be based on a public repository hosting service (GitHub, Bitbucket, mbed.org), your own service or even a different location on your system.

iriark01 · 2016-10-19T14:33:35Z

README.md

+
+When you create new (local) source control managed program or library, all revision history will exist only locally and the repository wouldn't be associated with remote one. To publish the local repository (while preserving the revision history) please follow these steps:
+1. Create new empty repository on the remote side - either based on public repository hosting service (Github, Bitbucket, mbed.org), service of your own or even different location on your system
+2. Copy the URL/location of the new repository in your clipboard and open command line in the local repository directory (for example change directory to `mbed-os-example/local-lib`).


Copy the URL of the new repository to your clipboard.

Open a command line in the local repository directory (for example, change directory to mbed-os-example/local-lib).

iriark01 · 2016-10-19T14:34:36Z

README.md

+3. To associate the local repository:
+ * For Git - run `git remote add origin <url-or-paht-to-your-remote-repo>`
+ * For Mercurial - edit .hg/hgrc and add (or replace if exists):
+ ```


Add a line break before the code, then indent the code by four spaces. This will place it as a code block in the numbered list, and continue the numbering after the code block.

iriark01 · 2016-10-19T14:35:13Z

README.md

+[paths]
+default = <url-or-paht-to-your-remote-repo>
+```
+4. Run `mbed publish` to publish your changes


Please add a period to the end of steps. It's not a universal law but it's the ARM style

iriark01 · 2016-10-19T14:35:54Z

README.md

+```
+4. Run `mbed publish` to publish your changes
+
+In scanario with nested local repositories, start with the leaf repositories first.


"In a scenario"
"start with the leaf repositories" (you don't need "first" - you already said "start with")

iriark01 · 2016-10-19T14:36:39Z

README.md

@@ -54,11 +54,11 @@ mbed CLI is supported on Windows, Linux and Mac OS X. We're keen to learn about

 ### Requirements

-* **Python** - mbed CLI is a Python script, so you'll need Python in order to use it. mbed CLI was tested with [version 2.7.9 of Python](https://www.python.org/download/releases/2.7/).
+* **Python** - mbed CLI is a Python script, so you'll need Python in order to use it. mbed CLI was tested with [version 2.7.9 of Python](https://www.python.org/download/releases/2.7/) and is not compatible with Python 3 at the moment of this writing.


You don't need "of this writing"

iriark01 · 2016-10-19T14:36:59Z

README.md

-    * [Git](https://git-scm.com/).
-    * [Mercurial](https://www.mercurial-scm.org/).
+    * [Git](https://git-scm.com/) - version 1.9.5 or later
+    * [Mercurial](https://www.mercurial-scm.org/) - version or 2.2.2 or later


"version 2.2.2 or later" (I assume that other "or" is there by mistake)

sg- · 2016-10-19T15:37:47Z

README.md

@@ -54,11 +54,11 @@ mbed CLI is supported on Windows, Linux and Mac OS X. We're keen to learn about

 ### Requirements

-* **Python** - mbed CLI is a Python script, so you'll need Python in order to use it. mbed CLI was tested with version 2.7.9 of Python. You can download that or a newer version [here](https://www.python.org/downloads/).
+* **Python** - mbed CLI is a Python script, so you'll need Python in order to use it. mbed CLI was tested with [version 2.7.9 of Python](https://www.python.org/download/releases/2.7/) and is not compatible with Python 3 at the moment of this writing.


I think other tools (htrun need python 2.7.11)

Add documentation for publishing local/new repositories ARMmbed#362 Add documentation regarding the specific Python, Git and Mercurial versions that mbed CLI supports ARMmbed#376

sg- · 2016-10-20T13:37:43Z

LGTM 👍

screamerbg mentioned this pull request Oct 19, 2016

"mbed publish" sends to a 404 in case the project is not Git-enabled #362

Closed

iriark01 reviewed Oct 19, 2016

View reviewed changes

screamerbg force-pushed the development branch 2 times, most recently from 6dac1b8 to 0d74efd Compare October 19, 2016 15:07

sg- reviewed Oct 20, 2016

View reviewed changes

Improve documentation (0.9.10)

441e827

Add documentation for publishing local/new repositories ARMmbed#362 Add documentation regarding the specific Python, Git and Mercurial versions that mbed CLI supports ARMmbed#376

screamerbg force-pushed the development branch from 0d74efd to 441e827 Compare October 20, 2016 13:36

screamerbg merged commit fbbc9dd into ARMmbed:master Oct 20, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve documentation (0.9.10) #379

Improve documentation (0.9.10) #379

Uh oh!

screamerbg commented Oct 19, 2016 •

edited by sg-

Loading

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

iriark01 Oct 19, 2016

Uh oh!

sg- Oct 19, 2016

Uh oh!

sg- commented Oct 20, 2016

Uh oh!

Uh oh!

		@@ -691,6 +691,22 @@ As with any mbed CLI command, `mbed update` uses the current directory as a work

		<span class="tips">Tip: Synchronizing library references: Before triggering an update, you might want to synchronize any changes that you've made to the program structure by running ``mbed sync``, which will update the necessary library references and get rid of the invalid ones.</span>

		## Publishing local program or library

Improve documentation (0.9.10) #379

Improve documentation (0.9.10) #379

Uh oh!

Conversation

screamerbg commented Oct 19, 2016 • edited by sg- Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Publishing a local program or library

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sg- commented Oct 20, 2016

Uh oh!

Uh oh!

screamerbg commented Oct 19, 2016 •

edited by sg-

Loading