Add debugging information for nacl_io library.

Add debugging information for nacl_io library.

BUG=none
R=
TEST=none
NOTRY=true
(documentation only change)

Committed: https://crrev.com/85a4a581610cf3016769de48e3f96bcd4f060147
Cr-Commit-Position: refs/heads/master@{#298533}

[jpmedley, 2014-09-30 16:56:49]

jmedley@chromium.org changed reviewers:
+ mkearney@chromium.org, ncbray@chromium.org, sbc@chromium.org

[Sam Clegg, 2014-09-30 17:17:02]

Thanks Joe!

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:528: itself.
I would put this paragraph in the NaCl document rather than the debugging
document.  Its basically saying that while nacl_io redirects things like
printf() the redirection doesn't apply to its own internal logging.  The
internal logging appears as normal stderr as described in this page already.  

So basically what this paragraph says is that nacl_io logging does go to the
standard place, but most other I/O under nacl_io does not.  Sorry if thats not a
very clear statement :(

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:536:
<redirecting-output-to-log>`.
This second paragraph is just about how to capture stderr of chrome and is not
related to nacl_io in particular.  If you want to keep the detail about
--user-data-dir you could add it above to the paragraph that reads: "By default
stdout and stderr will appear in Chrome's stdout and stderr stream..."

[Sam Clegg, 2014-09-30 17:28:37]

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:528: itself.
On 2014/09/30 17:17:02, Sam Clegg wrote:
> I would put this paragraph in the NaCl document rather than the debugging

Sorry, I meant to write "the nacl_io documentation".

> document.  Its basically saying that while nacl_io redirects things like
> printf() the redirection doesn't apply to its own internal logging.  The
> internal logging appears as normal stderr as described in this page already.  
> 
> So basically what this paragraph says is that nacl_io logging does go to the
> standard place, but most other I/O under nacl_io does not.  Sorry if thats not
a
> very clear statement :(

[jpmedley, 2014-10-01 21:17:12]

PTAL

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:528: itself.
On 2014/09/30 17:28:37, Sam Clegg wrote:
> On 2014/09/30 17:17:02, Sam Clegg wrote:
> > I would put this paragraph in the NaCl document rather than the debugging
> 
> Sorry, I meant to write "the nacl_io documentation".
> 
> > document.  Its basically saying that while nacl_io redirects things like
> > printf() the redirection doesn't apply to its own internal logging.  The
> > internal logging appears as normal stderr as described in this page already.
 
> > 
> > So basically what this paragraph says is that nacl_io logging does go to the
> > standard place, but most other I/O under nacl_io does not.  Sorry if thats
not
> a
> > very clear statement :(
> 

Done.

https://codereview.chromium.org/618823003/diff/40001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:536:
<redirecting-output-to-log>`.
On 2014/09/30 17:17:02, Sam Clegg wrote:
> This second paragraph is just about how to capture stderr of chrome and is not
> related to nacl_io in particular.  If you want to keep the detail about
> --user-data-dir you could add it above to the paragraph that reads: "By
default
> stdout and stderr will appear in Chrome's stdout and stderr stream..."

Done.

[Sam Clegg, 2014-10-01 21:52:15]

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/coding/nacl_io.rst (right):

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/coding/nacl_io.rst:33: for nacl_io, logging
writes directly to the ``stderr`` stream of the NaCl
, internal logging and error reporting writes directly...

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/coding/nacl_io.rst:35: nacl_io to avoid
circular calls to itself.
Perhaps put this in sub-sub-section called "Logging and Error Reporting" (or
maybe just in its own paragraph at the end).

The flow from this paragraph to the next is (IMHO) otherwise a little
interrupted.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:93: chrome (at least
on mac and linux). Be sure that when you launch chrome it
The stderr and stderr streams for chrome are available on Mac and Linux by
launching chrome from a terminal window.

(also join this with previous paragraph?)

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:98:
<redirecting-output-to-log>`.
This last sentence is duplicated from the previous paragraph.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:119: logs directly to
the stderr stream.
I would drop this sentence.  nacl_io is just like all other untrusted libraries
in this sense (since it is untrusted code).  NACLLOG (I think)  only effects
logging from trusted code such as sel_ldr.

[jpmedley, 2014-10-07 17:01:28]

On 2014/10/01 21:52:15, Sam Clegg wrote:
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> File native_client_sdk/src/doc/devguide/coding/nacl_io.rst (right):
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> native_client_sdk/src/doc/devguide/coding/nacl_io.rst:33: for nacl_io, logging
> writes directly to the ``stderr`` stream of the NaCl
> , internal logging and error reporting writes directly...
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> native_client_sdk/src/doc/devguide/coding/nacl_io.rst:35: nacl_io to avoid
> circular calls to itself.
> Perhaps put this in sub-sub-section called "Logging and Error Reporting" (or
> maybe just in its own paragraph at the end).
> 
> The flow from this paragraph to the next is (IMHO) otherwise a little
> interrupted.
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> native_client_sdk/src/doc/devguide/devcycle/debugging.rst:93: chrome (at least
> on mac and linux). Be sure that when you launch chrome it
> The stderr and stderr streams for chrome are available on Mac and Linux by
> launching chrome from a terminal window.
> 
> (also join this with previous paragraph?)
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> native_client_sdk/src/doc/devguide/devcycle/debugging.rst:98:
> <redirecting-output-to-log>`.
> This last sentence is duplicated from the previous paragraph.
> 
>
https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
> native_client_sdk/src/doc/devguide/devcycle/debugging.rst:119: logs directly
to
> the stderr stream.
> I would drop this sentence.  nacl_io is just like all other untrusted
libraries
> in this sense (since it is untrusted code).  NACLLOG (I think)  only effects
> logging from trusted code such as sel_ldr.

PTAL

[jpmedley, 2014-10-07 17:01:43]

PTAL

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/coding/nacl_io.rst (right):

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/coding/nacl_io.rst:33: for nacl_io, logging
writes directly to the ``stderr`` stream of the NaCl
On 2014/10/01 21:52:14, Sam Clegg wrote:
> , internal logging and error reporting writes directly...

Done.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/coding/nacl_io.rst:35: nacl_io to avoid
circular calls to itself.
On 2014/10/01 21:52:14, Sam Clegg wrote:
> Perhaps put this in sub-sub-section called "Logging and Error Reporting" (or
> maybe just in its own paragraph at the end).
> 
> The flow from this paragraph to the next is (IMHO) otherwise a little
> interrupted.

Done.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:93: chrome (at least
on mac and linux). Be sure that when you launch chrome it
On 2014/10/01 21:52:15, Sam Clegg wrote:
> The stderr and stderr streams for chrome are available on Mac and Linux by
> launching chrome from a terminal window.
> 
> (also join this with previous paragraph?)

Done.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:98:
<redirecting-output-to-log>`.
On 2014/10/01 21:52:15, Sam Clegg wrote:
> This last sentence is duplicated from the previous paragraph.  

Done.

https://codereview.chromium.org/618823003/diff/80001/native_client_sdk/src/do...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:119: logs directly to
the stderr stream.
On 2014/10/01 21:52:14, Sam Clegg wrote:
> I would drop this sentence.  nacl_io is just like all other untrusted
libraries
> in this sense (since it is untrusted code).  NACLLOG (I think)  only effects
> logging from trusted code such as sel_ldr. 

Done.

[Sam Clegg, 2014-10-07 18:49:37]

Great LGTM.

[jpmedley, 2014-10-07 18:51:15]

The CQ bit was checked by jmedley@chromium.org

[commit-bot: I haz the power, 2014-10-07 18:52:11]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/618823003/100001

[commit-bot: I haz the power, 2014-10-07 18:54:17]

Committed patchset #6 (id:100001) as 92c7a0684a7580eabab1b36216bef91a99fb779a

[commit-bot: I haz the power, 2014-10-07 18:55:34]

Patchset 6 (id:??) landed as
https://crrev.com/85a4a581610cf3016769de48e3f96bcd4f060147
Cr-Commit-Position: refs/heads/master@{#298533}