{"action":"created","comment":{"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments/199054493","pull_request_review_id":133096840,"id":199054493,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDE5OTA1NDQ5Mw==","diff_hunk":"@@ -12,6 +12,78 @@ A ``scripts`` directory includes scripts to analyze the trace data.\n Usage\n *****\n \n+The ``acrntrace`` tool runs on the Service OS (SOS) to capture trace data and\n+output to trace file under ``/tmp/acrntrace`` with raw (binary) data format.\n+\n+Options:\n+\n+    -h:\n+       print this message\n+\n+    -t:\n+       period_in_ms: specify polling interval [1-999]\n+\n+    -c:\n+       clear the buffered old data\n+\n+The ``acrntrace_format.py`` is a offline tool for parsing trace data (as output\n+by acrntrace) to human-readable formats based on given format.\n+\n+acrntrace_format.py [options] [formats] [trace_data]","path":"tools/acrntrace/README.rst","position":21,"original_position":21,"commit_id":"7f7657c237239dd055eb43f8dc9b796a229ede8e","original_commit_id":"7f7657c237239dd055eb43f8dc9b796a229ede8e","user":{"login":"dbkinder","id":11063618,"node_id":"MDQ6VXNlcjExMDYzNjE4","avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"body":"I'd suggest writing this as:\r\n\r\n    Here's an explanation of the tool's parameters:\r\n\r\n    .. code-block:: none\r\n\r\n       acrntrace_format.py [options] [formats] [trace_data]\r\n\r\n    Options:\r\n\r\n    -h    print this message\r\n\r\n    - A *formats* file specifies the rules to reformat the binary data collected by\r\n      ``acrntrace`` into a human-readable text form.  The rules in this file are of\r\n      the form::\r\n\r\n        event_id  text_format_string\r\n\r\n      The text_format_string may include format specifiers, such as\r\n      ``%(cpu)d``, ``%(tsc)d``, ``%(event)d``, ``%(1)d````, and %(2)d``.\r\n      The 'd' format specifier outputs in decimal, alternatively 'x' will\r\n      output in hexadecimal and 'o' will output in octal.\r\n\r\n      These respectively correspond to the CPU number (cpu), timestamp\r\n      counter (tsc), event ID (event) and the data logged in the trace file.\r\n      There can be only one such rule for each type of event.\r\n     ","created_at":"2018-06-29T05:12:05Z","updated_at":"2018-06-29T05:13:26Z","html_url":"https://github.com/projectacrn/acrn-hypervisor/pull/531#discussion_r199054493","pull_request_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments/199054493"},"html":{"href":"https://github.com/projectacrn/acrn-hypervisor/pull/531#discussion_r199054493"},"pull_request":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531"}}},"pull_request":{"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531","id":198205322,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk4MjA1MzIy","html_url":"https://github.com/projectacrn/acrn-hypervisor/pull/531","diff_url":"https://github.com/projectacrn/acrn-hypervisor/pull/531.diff","patch_url":"https://github.com/projectacrn/acrn-hypervisor/pull/531.patch","issue_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/531","number":531,"state":"open","locked":false,"title":"tools: acrntrace: Updata README.rst","user":{"login":"KaigeFu","id":38653193,"node_id":"MDQ6VXNlcjM4NjUzMTkz","avatar_url":"https://avatars2.githubusercontent.com/u/38653193?v=4","gravatar_id":"","url":"https://api.github.com/users/KaigeFu","html_url":"https://github.com/KaigeFu","followers_url":"https://api.github.com/users/KaigeFu/followers","following_url":"https://api.github.com/users/KaigeFu/following{/other_user}","gists_url":"https://api.github.com/users/KaigeFu/gists{/gist_id}","starred_url":"https://api.github.com/users/KaigeFu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KaigeFu/subscriptions","organizations_url":"https://api.github.com/users/KaigeFu/orgs","repos_url":"https://api.github.com/users/KaigeFu/repos","events_url":"https://api.github.com/users/KaigeFu/events{/privacy}","received_events_url":"https://api.github.com/users/KaigeFu/received_events","type":"User","site_admin":false},"body":"-Add acrntrace_format.py usage to README.rst\r\n-Add acrntrace usage to README.rst\r\n-Add acrnanalyze.py to README.rst\r\n\r\nSigned-off-by: Kaige Fu <kaige.fu@intel.com>\r\nReviewed-by: Yan, Like <like.yan@intel.com>\r\nReviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>\r\nAcked-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>","created_at":"2018-06-29T03:20:55Z","updated_at":"2018-06-29T05:13:26Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2b2168ad368c6f0290c64653c37e1df0f8e73cf5","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531/commits","review_comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531/comments","review_comment_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments{/number}","comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/531/comments","statuses_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/7f7657c237239dd055eb43f8dc9b796a229ede8e","head":{"label":"KaigeFu:acrntrace_refactor_s1_doc","ref":"acrntrace_refactor_s1_doc","sha":"7f7657c237239dd055eb43f8dc9b796a229ede8e","user":{"login":"KaigeFu","id":38653193,"node_id":"MDQ6VXNlcjM4NjUzMTkz","avatar_url":"https://avatars2.githubusercontent.com/u/38653193?v=4","gravatar_id":"","url":"https://api.github.com/users/KaigeFu","html_url":"https://github.com/KaigeFu","followers_url":"https://api.github.com/users/KaigeFu/followers","following_url":"https://api.github.com/users/KaigeFu/following{/other_user}","gists_url":"https://api.github.com/users/KaigeFu/gists{/gist_id}","starred_url":"https://api.github.com/users/KaigeFu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KaigeFu/subscriptions","organizations_url":"https://api.github.com/users/KaigeFu/orgs","repos_url":"https://api.github.com/users/KaigeFu/repos","events_url":"https://api.github.com/users/KaigeFu/events{/privacy}","received_events_url":"https://api.github.com/users/KaigeFu/received_events","type":"User","site_admin":false},"repo":{"id":139082462,"node_id":"MDEwOlJlcG9zaXRvcnkxMzkwODI0NjI=","name":"acrn-hypervisor","full_name":"KaigeFu/acrn-hypervisor","owner":{"login":"KaigeFu","id":38653193,"node_id":"MDQ6VXNlcjM4NjUzMTkz","avatar_url":"https://avatars2.githubusercontent.com/u/38653193?v=4","gravatar_id":"","url":"https://api.github.com/users/KaigeFu","html_url":"https://github.com/KaigeFu","followers_url":"https://api.github.com/users/KaigeFu/followers","following_url":"https://api.github.com/users/KaigeFu/following{/other_user}","gists_url":"https://api.github.com/users/KaigeFu/gists{/gist_id}","starred_url":"https://api.github.com/users/KaigeFu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KaigeFu/subscriptions","organizations_url":"https://api.github.com/users/KaigeFu/orgs","repos_url":"https://api.github.com/users/KaigeFu/repos","events_url":"https://api.github.com/users/KaigeFu/events{/privacy}","received_events_url":"https://api.github.com/users/KaigeFu/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/KaigeFu/acrn-hypervisor","description":"Project ACRN hypervisor ","fork":true,"url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor","forks_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/forks","keys_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/teams","hooks_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/hooks","issue_events_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/issues/events{/number}","events_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/events","assignees_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/assignees{/user}","branches_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/branches{/branch}","tags_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/tags","blobs_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/git/refs{/sha}","trees_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/statuses/{sha}","languages_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/languages","stargazers_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/stargazers","contributors_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/contributors","subscribers_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/subscribers","subscription_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/subscription","commits_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/commits{/sha}","git_commits_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/git/commits{/sha}","comments_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/comments{/number}","issue_comment_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/issues/comments{/number}","contents_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/contents/{+path}","compare_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/merges","archive_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/downloads","issues_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/issues{/number}","pulls_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/pulls{/number}","milestones_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/milestones{/number}","notifications_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/labels{/name}","releases_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/releases{/id}","deployments_url":"https://api.github.com/repos/KaigeFu/acrn-hypervisor/deployments","created_at":"2018-06-29T00:38:29Z","updated_at":"2018-06-29T00:38:33Z","pushed_at":"2018-06-29T03:20:39Z","git_url":"git://github.com/KaigeFu/acrn-hypervisor.git","ssh_url":"git@github.com:KaigeFu/acrn-hypervisor.git","clone_url":"https://github.com/KaigeFu/acrn-hypervisor.git","svn_url":"https://github.com/KaigeFu/acrn-hypervisor","homepage":"","size":8387,"stargazers_count":0,"watchers_count":0,"language":"C","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause","node_id":"MDc6TGljZW5zZTU="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"projectacrn:master","ref":"master","sha":"81b113cfa591c8b07757ef863bbaf4dae05fe9ac","user":{"login":"projectacrn","id":36865262,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM2ODY1MjYy","avatar_url":"https://avatars1.githubusercontent.com/u/36865262?v=4","gravatar_id":"","url":"https://api.github.com/users/projectacrn","html_url":"https://github.com/projectacrn","followers_url":"https://api.github.com/users/projectacrn/followers","following_url":"https://api.github.com/users/projectacrn/following{/other_user}","gists_url":"https://api.github.com/users/projectacrn/gists{/gist_id}","starred_url":"https://api.github.com/users/projectacrn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectacrn/subscriptions","organizations_url":"https://api.github.com/users/projectacrn/orgs","repos_url":"https://api.github.com/users/projectacrn/repos","events_url":"https://api.github.com/users/projectacrn/events{/privacy}","received_events_url":"https://api.github.com/users/projectacrn/received_events","type":"Organization","site_admin":false},"repo":{"id":123983554,"node_id":"MDEwOlJlcG9zaXRvcnkxMjM5ODM1NTQ=","name":"acrn-hypervisor","full_name":"projectacrn/acrn-hypervisor","owner":{"login":"projectacrn","id":36865262,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM2ODY1MjYy","avatar_url":"https://avatars1.githubusercontent.com/u/36865262?v=4","gravatar_id":"","url":"https://api.github.com/users/projectacrn","html_url":"https://github.com/projectacrn","followers_url":"https://api.github.com/users/projectacrn/followers","following_url":"https://api.github.com/users/projectacrn/following{/other_user}","gists_url":"https://api.github.com/users/projectacrn/gists{/gist_id}","starred_url":"https://api.github.com/users/projectacrn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectacrn/subscriptions","organizations_url":"https://api.github.com/users/projectacrn/orgs","repos_url":"https://api.github.com/users/projectacrn/repos","events_url":"https://api.github.com/users/projectacrn/events{/privacy}","received_events_url":"https://api.github.com/users/projectacrn/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/projectacrn/acrn-hypervisor","description":"Project ACRN hypervisor ","fork":false,"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor","forks_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/forks","keys_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/teams","hooks_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/hooks","issue_events_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/events{/number}","events_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/events","assignees_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/assignees{/user}","branches_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/branches{/branch}","tags_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/tags","blobs_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/refs{/sha}","trees_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/{sha}","languages_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/languages","stargazers_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/stargazers","contributors_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/contributors","subscribers_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/subscribers","subscription_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/subscription","commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/commits{/sha}","git_commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/commits{/sha}","comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/comments{/number}","issue_comment_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/comments{/number}","contents_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/contents/{+path}","compare_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/merges","archive_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/downloads","issues_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues{/number}","pulls_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls{/number}","milestones_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/milestones{/number}","notifications_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/labels{/name}","releases_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/releases{/id}","deployments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/deployments","created_at":"2018-03-05T21:52:25Z","updated_at":"2018-06-29T05:11:52Z","pushed_at":"2018-06-29T05:11:50Z","git_url":"git://github.com/projectacrn/acrn-hypervisor.git","ssh_url":"git@github.com:projectacrn/acrn-hypervisor.git","clone_url":"https://github.com/projectacrn/acrn-hypervisor.git","svn_url":"https://github.com/projectacrn/acrn-hypervisor","homepage":"","size":8384,"stargazers_count":192,"watchers_count":192,"language":"C","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":129,"mirror_url":null,"archived":false,"open_issues_count":32,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause","node_id":"MDc6TGljZW5zZTU="},"forks":129,"open_issues":32,"watchers":192,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531"},"html":{"href":"https://github.com/projectacrn/acrn-hypervisor/pull/531"},"issue":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/531"},"comments":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/531/comments"},"review_comments":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531/comments"},"review_comment":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/531/commits"},"statuses":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/7f7657c237239dd055eb43f8dc9b796a229ede8e"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"dbkinder"}}