{"action":"created","comment":{"url":"https://api.github.com/repos/ARMmbed/valinor/pulls/comments/34372751","id":34372751,"diff_hunk":"@@ -1,6 +1,44 @@\n ##valinor\n [![Circle CI](https://circleci.com/gh/ARMmbed/valinor.svg?style=svg&circle-token=d70b5c2db296d7886f68383cb07c79e7d7bcce14)](https://circleci.com/gh/ARMmbed/valinor)\n \n-Generate IDE project files to debug ELF files.\n+Generate debugger project files, and launch a debugger, to debug an ELF file.\n \n+valinor is designed to be used as a proxy debug command for yotta targets to\n+provide as their `scripts.debug` command. See the [yotta targets\n+guide](http://docs.yottabuild.org/tutorial/targets.html#debug-support) for more\n+details about debug support in yotta.\n \n+### Usage\n+\n+```sh\n+valinor [-t IDE_TOOL] [-d PROJECT_DIR] [-n] --target TARGET executable\n+```\n+\n+ * **`TARGET`** is a target name that project_generator will accept, for example K64F.\n+ * **`-t IDE_TOOL, --tool IDE_TOOL`** The Debug tool (IDE) to generate for. If\n+   omitted, a debug project will be generated for an IDE detected on your\n+   system, defaulting to opening a GDB debug session, if no known IDEs are\n+   detected.\n+ * **`-d PROJECT_DIR, --project-dir PROJECT_DIR`** The directory in which to\n+   generate any necessary project files. Defaults to the directory of the\n+   executable argument.\n+ * **`-n, --no-open`** Do not open the debug session, just generate the necessary\n+   files to enable debugging, and print the command that would be necessary to\n+   proceed.\n+ * **`--target TARGET`** The target board to generate a project file for (e.g.\n+   K64F). This name is passed to\n+   [`project_generator`](https://github.com/project-generator/project_generator),\n+   so any name that `project_generator` accepts will work. \n+ * `executable` Path to an ELF file (with debug symbols) to debug.\n+\n+### Using in yotta target descriptions\n+\n+To use valinor to add debug support to a yotta target description add this to\n+your target.json file (replacing K64F with the project_generator target ID for\n+the chip or board on your target):\n+\n+```json\n+    \"scripts\":{\n+        \"debug\": [\"valinor\", \"--target\", \"K64F\", \"$program\"]","path":"readme.md","position":43,"original_position":43,"commit_id":"b76dcdc641e254bd6c744e2c2b3eccdd22841e87","original_commit_id":"b76dcdc641e254bd6c744e2c2b3eccdd22841e87","user":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars.githubusercontent.com/u/2963726?v=3","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"body":"Can we change K64F to frdm-k64f? :-)","created_at":"2015-07-10T16:46:14Z","updated_at":"2015-07-10T16:46:14Z","html_url":"https://github.com/ARMmbed/valinor/pull/5#discussion_r34372751","pull_request_url":"https://api.github.com/repos/ARMmbed/valinor/pulls/5","_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/comments/34372751"},"html":{"href":"https://github.com/ARMmbed/valinor/pull/5#discussion_r34372751"},"pull_request":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/5"}}},"pull_request":{"url":"https://api.github.com/repos/ARMmbed/valinor/pulls/5","id":39702343,"html_url":"https://github.com/ARMmbed/valinor/pull/5","diff_url":"https://github.com/ARMmbed/valinor/pull/5.diff","patch_url":"https://github.com/ARMmbed/valinor/pull/5.patch","issue_url":"https://api.github.com/repos/ARMmbed/valinor/issues/5","number":5,"state":"open","locked":false,"title":"fill out readme","user":{"login":"autopulated","id":3456211,"avatar_url":"https://avatars.githubusercontent.com/u/3456211?v=3","gravatar_id":"","url":"https://api.github.com/users/autopulated","html_url":"https://github.com/autopulated","followers_url":"https://api.github.com/users/autopulated/followers","following_url":"https://api.github.com/users/autopulated/following{/other_user}","gists_url":"https://api.github.com/users/autopulated/gists{/gist_id}","starred_url":"https://api.github.com/users/autopulated/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/autopulated/subscriptions","organizations_url":"https://api.github.com/users/autopulated/orgs","repos_url":"https://api.github.com/users/autopulated/repos","events_url":"https://api.github.com/users/autopulated/events{/privacy}","received_events_url":"https://api.github.com/users/autopulated/received_events","type":"User","site_admin":false},"body":"cc @iriark01","created_at":"2015-07-10T16:44:56Z","updated_at":"2015-07-10T16:46:14Z","closed_at":null,"merged_at":null,"merge_commit_sha":"309201224fa3330d256a63feb0a7e280bebabfb2","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/ARMmbed/valinor/pulls/5/commits","review_comments_url":"https://api.github.com/repos/ARMmbed/valinor/pulls/5/comments","review_comment_url":"https://api.github.com/repos/ARMmbed/valinor/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ARMmbed/valinor/issues/5/comments","statuses_url":"https://api.github.com/repos/ARMmbed/valinor/statuses/b76dcdc641e254bd6c744e2c2b3eccdd22841e87","head":{"label":"autopulated:master","ref":"master","sha":"b76dcdc641e254bd6c744e2c2b3eccdd22841e87","user":{"login":"autopulated","id":3456211,"avatar_url":"https://avatars.githubusercontent.com/u/3456211?v=3","gravatar_id":"","url":"https://api.github.com/users/autopulated","html_url":"https://github.com/autopulated","followers_url":"https://api.github.com/users/autopulated/followers","following_url":"https://api.github.com/users/autopulated/following{/other_user}","gists_url":"https://api.github.com/users/autopulated/gists{/gist_id}","starred_url":"https://api.github.com/users/autopulated/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/autopulated/subscriptions","organizations_url":"https://api.github.com/users/autopulated/orgs","repos_url":"https://api.github.com/users/autopulated/repos","events_url":"https://api.github.com/users/autopulated/events{/privacy}","received_events_url":"https://api.github.com/users/autopulated/received_events","type":"User","site_admin":false},"repo":{"id":38890765,"name":"valinor","full_name":"autopulated/valinor","owner":{"login":"autopulated","id":3456211,"avatar_url":"https://avatars.githubusercontent.com/u/3456211?v=3","gravatar_id":"","url":"https://api.github.com/users/autopulated","html_url":"https://github.com/autopulated","followers_url":"https://api.github.com/users/autopulated/followers","following_url":"https://api.github.com/users/autopulated/following{/other_user}","gists_url":"https://api.github.com/users/autopulated/gists{/gist_id}","starred_url":"https://api.github.com/users/autopulated/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/autopulated/subscriptions","organizations_url":"https://api.github.com/users/autopulated/orgs","repos_url":"https://api.github.com/users/autopulated/repos","events_url":"https://api.github.com/users/autopulated/events{/privacy}","received_events_url":"https://api.github.com/users/autopulated/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/autopulated/valinor","description":"Generate Project Files to Debug ELF files.","fork":true,"url":"https://api.github.com/repos/autopulated/valinor","forks_url":"https://api.github.com/repos/autopulated/valinor/forks","keys_url":"https://api.github.com/repos/autopulated/valinor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/autopulated/valinor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/autopulated/valinor/teams","hooks_url":"https://api.github.com/repos/autopulated/valinor/hooks","issue_events_url":"https://api.github.com/repos/autopulated/valinor/issues/events{/number}","events_url":"https://api.github.com/repos/autopulated/valinor/events","assignees_url":"https://api.github.com/repos/autopulated/valinor/assignees{/user}","branches_url":"https://api.github.com/repos/autopulated/valinor/branches{/branch}","tags_url":"https://api.github.com/repos/autopulated/valinor/tags","blobs_url":"https://api.github.com/repos/autopulated/valinor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/autopulated/valinor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/autopulated/valinor/git/refs{/sha}","trees_url":"https://api.github.com/repos/autopulated/valinor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/autopulated/valinor/statuses/{sha}","languages_url":"https://api.github.com/repos/autopulated/valinor/languages","stargazers_url":"https://api.github.com/repos/autopulated/valinor/stargazers","contributors_url":"https://api.github.com/repos/autopulated/valinor/contributors","subscribers_url":"https://api.github.com/repos/autopulated/valinor/subscribers","subscription_url":"https://api.github.com/repos/autopulated/valinor/subscription","commits_url":"https://api.github.com/repos/autopulated/valinor/commits{/sha}","git_commits_url":"https://api.github.com/repos/autopulated/valinor/git/commits{/sha}","comments_url":"https://api.github.com/repos/autopulated/valinor/comments{/number}","issue_comment_url":"https://api.github.com/repos/autopulated/valinor/issues/comments{/number}","contents_url":"https://api.github.com/repos/autopulated/valinor/contents/{+path}","compare_url":"https://api.github.com/repos/autopulated/valinor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/autopulated/valinor/merges","archive_url":"https://api.github.com/repos/autopulated/valinor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/autopulated/valinor/downloads","issues_url":"https://api.github.com/repos/autopulated/valinor/issues{/number}","pulls_url":"https://api.github.com/repos/autopulated/valinor/pulls{/number}","milestones_url":"https://api.github.com/repos/autopulated/valinor/milestones{/number}","notifications_url":"https://api.github.com/repos/autopulated/valinor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/autopulated/valinor/labels{/name}","releases_url":"https://api.github.com/repos/autopulated/valinor/releases{/id}","created_at":"2015-07-10T16:32:30Z","updated_at":"2015-07-10T16:32:30Z","pushed_at":"2015-07-10T16:44:10Z","git_url":"git://github.com/autopulated/valinor.git","ssh_url":"git@github.com:autopulated/valinor.git","clone_url":"https://github.com/autopulated/valinor.git","svn_url":"https://github.com/autopulated/valinor","homepage":null,"size":269,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ARMmbed:master","ref":"master","sha":"a21f78af78c83e15aa15d56ddd48c56bc3be852b","user":{"login":"ARMmbed","id":8916057,"avatar_url":"https://avatars.githubusercontent.com/u/8916057?v=3","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"repo":{"id":30650217,"name":"valinor","full_name":"ARMmbed/valinor","owner":{"login":"ARMmbed","id":8916057,"avatar_url":"https://avatars.githubusercontent.com/u/8916057?v=3","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ARMmbed/valinor","description":"Generate Project Files to Debug ELF files.","fork":false,"url":"https://api.github.com/repos/ARMmbed/valinor","forks_url":"https://api.github.com/repos/ARMmbed/valinor/forks","keys_url":"https://api.github.com/repos/ARMmbed/valinor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ARMmbed/valinor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ARMmbed/valinor/teams","hooks_url":"https://api.github.com/repos/ARMmbed/valinor/hooks","issue_events_url":"https://api.github.com/repos/ARMmbed/valinor/issues/events{/number}","events_url":"https://api.github.com/repos/ARMmbed/valinor/events","assignees_url":"https://api.github.com/repos/ARMmbed/valinor/assignees{/user}","branches_url":"https://api.github.com/repos/ARMmbed/valinor/branches{/branch}","tags_url":"https://api.github.com/repos/ARMmbed/valinor/tags","blobs_url":"https://api.github.com/repos/ARMmbed/valinor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ARMmbed/valinor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ARMmbed/valinor/git/refs{/sha}","trees_url":"https://api.github.com/repos/ARMmbed/valinor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ARMmbed/valinor/statuses/{sha}","languages_url":"https://api.github.com/repos/ARMmbed/valinor/languages","stargazers_url":"https://api.github.com/repos/ARMmbed/valinor/stargazers","contributors_url":"https://api.github.com/repos/ARMmbed/valinor/contributors","subscribers_url":"https://api.github.com/repos/ARMmbed/valinor/subscribers","subscription_url":"https://api.github.com/repos/ARMmbed/valinor/subscription","commits_url":"https://api.github.com/repos/ARMmbed/valinor/commits{/sha}","git_commits_url":"https://api.github.com/repos/ARMmbed/valinor/git/commits{/sha}","comments_url":"https://api.github.com/repos/ARMmbed/valinor/comments{/number}","issue_comment_url":"https://api.github.com/repos/ARMmbed/valinor/issues/comments{/number}","contents_url":"https://api.github.com/repos/ARMmbed/valinor/contents/{+path}","compare_url":"https://api.github.com/repos/ARMmbed/valinor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ARMmbed/valinor/merges","archive_url":"https://api.github.com/repos/ARMmbed/valinor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ARMmbed/valinor/downloads","issues_url":"https://api.github.com/repos/ARMmbed/valinor/issues{/number}","pulls_url":"https://api.github.com/repos/ARMmbed/valinor/pulls{/number}","milestones_url":"https://api.github.com/repos/ARMmbed/valinor/milestones{/number}","notifications_url":"https://api.github.com/repos/ARMmbed/valinor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ARMmbed/valinor/labels{/name}","releases_url":"https://api.github.com/repos/ARMmbed/valinor/releases{/id}","created_at":"2015-02-11T14:00:23Z","updated_at":"2015-05-17T20:23:47Z","pushed_at":"2015-07-10T16:44:57Z","git_url":"git://github.com/ARMmbed/valinor.git","ssh_url":"git@github.com:ARMmbed/valinor.git","clone_url":"https://github.com/ARMmbed/valinor.git","svn_url":"https://github.com/ARMmbed/valinor","homepage":null,"size":472,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":3,"forks":2,"open_issues":3,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/5"},"html":{"href":"https://github.com/ARMmbed/valinor/pull/5"},"issue":{"href":"https://api.github.com/repos/ARMmbed/valinor/issues/5"},"comments":{"href":"https://api.github.com/repos/ARMmbed/valinor/issues/5/comments"},"review_comments":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/5/comments"},"review_comment":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ARMmbed/valinor/pulls/5/commits"},"statuses":{"href":"https://api.github.com/repos/ARMmbed/valinor/statuses/b76dcdc641e254bd6c744e2c2b3eccdd22841e87"}}}}