[PR196 *] Adding documentation for forthcoming changes in 0.4.0 #250

jbohren · 2015-12-16T01:23:50Z

View online here: http://jbohren-ct.readthedocs.org/en/pre-0.4.0-docs/

Includes the following:

new execution framework design
sets local sphinx style to readthedocs style
reorganizes main index for easier navigation

To build locally:

cd docs
make html

Outstanding Issues

jbohren · 2015-12-21T17:26:24Z

This has been rebased to incorporate changes from #244 and the new test harness.

NikolausDemmel · 2016-01-22T17:10:17Z

a.k.a. "turbo" option

This is gold :-D

I've been using it and it really is a turbo for large workspaces.

…local sphinx style, and reorganizing main index

- updated build type stages - added scripts for recording examples - added scripts for capturing CLI interfaces to txt files - moved catkin tools history to specific history page - simplified index - updated build mechanics for new features - added migration guide with troubleshooting based on observed use cases - updated quick start with asciinemas - updated build with asciinemas - added env verb - added example resources to installation

…graphs, fixing some typos

Conflicts: docs/mechanics.rst docs/quick_start.rst

- regenerating examples and cli interfaces - switching all text to sentence-per-line - adding scripts and documentation for regenerating examples - moving --locate-extra-shell-verbs to locate verb - adding details on linked develspace

jbohren · 2016-04-13T23:14:36Z

@wjwwood These docs are all updated for all of the pre-0.4.0 changes and should be good to merge.

dirk-thomas · 2016-04-13T23:35:21Z

docs/index.rst


 Each of the following verbs is built-in to the ``catkin`` command and has its own detailed documentation:

 - :doc:`build -- Build packages in a catkin workspace <verbs/catkin_build>`
 - :doc:`config -- Configure a catkin workspace's layout and settings <verbs/catkin_config>`
 - :doc:`clean -- Clean products generated in a catkin workspace <verbs/catkin_clean>`
 - :doc:`create -- Create structures like Catkin packages <verbs/catkin_create>`
+- :doc:`env -- Run commands with a modified environemnt <verbs/catkin_env>`


Spelling: environemnt

jbohren · 2016-04-13T23:35:49Z

@wjwwood All tests passing. If you merge this, I can send out the call for testing once the docs are live on rtd.

wjwwood · 2016-04-13T23:36:50Z

@jbohren that sounds good, I'm looking at it now.

jbohren · 2016-04-13T23:53:03Z

@wjwwood Hold on merging while I add a module to sphinx to check spelling, there are more mistakes than the ones @dirk-thomas found, obviously.

wjwwood · 2016-04-13T23:56:03Z

@jbohren great idea. I'm still reviewing it anyways.

jbohren · 2016-04-14T00:18:10Z

@wjwwood 53d1205 should now fail if there are any spelling errors (there still are, but I want to see it break the CI before fixing it)

jbohren · 2016-04-14T00:32:41Z

Ok it looks like it's working on OSX but needs an Ubuntu system package.

jbohren · 2016-04-14T01:14:01Z

We now have CI doc spell checking.

wjwwood · 2016-04-14T01:55:54Z

I rebuilt this branch on RTD, so that I can see the updated output from the shell scripts. Does this need to be rebased since #293.

wjwwood · 2016-04-14T01:56:29Z

That last sentence should have been a question. Otherwise I think things like the "log" space won't show up in the output of the quickstart page.

wjwwood · 2016-04-14T02:11:18Z

I think you should rebase this before merging. I just looked at the merged result and it resulted in some strange three-way merges which I'm not convinced make sense afterwards. Related to that is that rebasing cannot be done cleanly. I can also not squash it properly. Not sure what's going on.

Also your CI job doesn't work with the latest change (it timed-out because you don't pass -y to apt-get).

wjwwood · 2016-04-14T02:14:11Z

It's really strange because the commit e5c5224 is in this pr's commit list, but it doesn't show up in the log of a clean git clone https://github.com/catkin/catkin_tools -b pre-0.4.0-docs. Not sure what's going on.

wjwwood · 2016-04-14T02:20:38Z

Never mind, I have the commit, but it's way back in the git log. It's a very strange branch.

wjwwood · 2016-04-14T02:51:27Z

@jbohren I pushed a branch of this which is rebased on master: https://github.com/catkin/catkin_tools/tree/pre-0.4.0-docs-rebase (including your latest commit a2e21ee) if you're interested. That one Fix typos commit really screwed things up.

wjwwood · 2016-04-14T02:57:20Z

btw, it looks like the RTD build fails because of your spellchecker: http://readthedocs.org/projects/catkin-tools/builds/3906804/

jbohren · 2016-04-14T03:36:46Z

@jbohren I pushed a branch of this which is rebased on master: https://github.com/catkin/catkin_tools/tree/pre-0.4.0-docs-rebase (including your latest commit a2e21ee) if you're interested. That one Fix typos commit really screwed things up.

Yeah I created a PR from it as #318. You mean the fix typos commit 472ead0? I was trying to make sure @fudger's commit was in there in a reasonable way, it looks like your rebase did it properly, though.

btw, it looks like the RTD build fails because of your spellchecker: http://readthedocs.org/projects/catkin-tools/builds/3906804/

I added a separate sphinx conf to be used for the CI only over in #318.

Closing this in favor of #318.

jbohren added this to the 0.4.0 - Second Beta Announcement milestone Dec 16, 2015

jbohren added enhancement documentation labels Dec 16, 2015

jbohren mentioned this pull request Dec 17, 2015

[PR196 1/3] New asyncio-based execution engine #249

Merged

21 tasks

jbohren changed the title ~~Adding documentation for forthcoming changes in 0.4.0 (PR#196)~~ [PR196] Adding documentation for forthcoming changes in 0.4.0 Dec 18, 2015

jbohren changed the title ~~[PR196] Adding documentation for forthcoming changes in 0.4.0~~ [PR196 *] Adding documentation for forthcoming changes in 0.4.0 Dec 18, 2015

jbohren force-pushed the pre-0.4.0-docs branch from d472094 to 143c9de Compare December 21, 2015 17:25

jbohren mentioned this pull request Jan 14, 2016

[PR196 1/3+] Generate .catkin develspace manifest file #271

Merged

jbohren mentioned this pull request Jan 22, 2016

[PR196 2/3] Adding linked develspace support #276

Merged

6 tasks

jbohren mentioned this pull request Jan 23, 2016

Causes computer to occasionally run out of memory #167

Closed

jbohren added 4 commits February 8, 2016 09:27

doc: Adding documentation for forthcoming changes in 0.4.0, updating …

e5c5224

…local sphinx style, and reorganizing main index

doc: Updating CMake build type build stages

4a91a4b

docs: Adding migration, mem-limit, env-caching docs

6806ce3

jbohren force-pushed the pre-0.4.0-docs branch from 3104694 to c107a12 Compare February 8, 2016 14:28

This was referenced Feb 12, 2016

[PR196 3/3] Adding support for partial workspace cleaning #293

Merged

[major] executor/clean: Adding per-package cleaning, linked develspaces, and a new execution pipeline #196

Closed

Alexander Schaefer and others added 5 commits February 26, 2016 11:47

Fix some typos.

472ead0

docs: Updating CLI interfaces, re-aligning sentences to lines in para…

5597566

…graphs, fixing some typos

Merge remote-tracking branch 'fudger/master' into pre-0.4.0-docs

1f7fd12

Conflicts: docs/mechanics.rst docs/quick_start.rst

Merge remote-tracking branch 'origin/master' into pre-0.4.0-docs

6331f8b

docs: updating after merging #293

878f48d

- regenerating examples and cli interfaces - switching all text to sentence-per-line - adding scripts and documentation for regenerating examples - moving --locate-extra-shell-verbs to locate verb - adding details on linked develspace

jbohren force-pushed the pre-0.4.0-docs branch from 8317023 to 878f48d Compare April 13, 2016 23:08

docs: adding note on cmake isystem bug

0c66a2f

jbohren mentioned this pull request Apr 13, 2016

Correct typos #299

Closed

jbohren modified the milestones: 0.4.0 - Second Beta Announcement, 0.5.0 - Optimization, Scalability, and Testing Apr 13, 2016

This was referenced Apr 13, 2016

add migration documentation from catkin_make and cmi #22

Closed

Somehow list known external verbs #71

Closed

dirk-thomas reviewed Apr 13, 2016
View reviewed changes

jbohren force-pushed the pre-0.4.0-docs branch from 53d1205 to 42eb763 Compare April 14, 2016 00:25

jbohren force-pushed the pre-0.4.0-docs branch from 42eb763 to bdf42f1 Compare April 14, 2016 00:58

docs: Fixing a bunch of spelling errors, adding CI check

8547bbf

jbohren force-pushed the pre-0.4.0-docs branch from bdf42f1 to 8547bbf Compare April 14, 2016 01:08

docs: fixing typos, adding -y for CI build

a2e21ee

jbohren force-pushed the pre-0.4.0-docs branch from accdf1a to a2e21ee Compare April 14, 2016 02:48

jbohren mentioned this pull request Apr 14, 2016

pre-0.4.0 Documentation #318

Merged

jbohren closed this Apr 14, 2016

jbohren deleted the pre-0.4.0-docs branch April 14, 2016 18:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PR196 *] Adding documentation for forthcoming changes in 0.4.0 #250

[PR196 *] Adding documentation for forthcoming changes in 0.4.0 #250

jbohren commented Dec 16, 2015

jbohren commented Dec 21, 2015

NikolausDemmel commented Jan 22, 2016

jbohren commented Apr 13, 2016

dirk-thomas Apr 13, 2016

jbohren commented Apr 13, 2016

wjwwood commented Apr 13, 2016

jbohren commented Apr 13, 2016

wjwwood commented Apr 13, 2016

jbohren commented Apr 14, 2016

jbohren commented Apr 14, 2016

jbohren commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

jbohren commented Apr 14, 2016

[PR196 *] Adding documentation for forthcoming changes in 0.4.0 #250

[PR196 *] Adding documentation for forthcoming changes in 0.4.0 #250

Conversation

jbohren commented Dec 16, 2015

Outstanding Issues

jbohren commented Dec 21, 2015

NikolausDemmel commented Jan 22, 2016

jbohren commented Apr 13, 2016

dirk-thomas Apr 13, 2016

Choose a reason for hiding this comment

jbohren commented Apr 13, 2016

wjwwood commented Apr 13, 2016

jbohren commented Apr 13, 2016

wjwwood commented Apr 13, 2016

jbohren commented Apr 14, 2016

jbohren commented Apr 14, 2016

jbohren commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

wjwwood commented Apr 14, 2016

jbohren commented Apr 14, 2016