Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logging documentation is confusing #886

Closed
eschnett opened this issue Sep 26, 2013 · 1 comment

Comments

Projects
None yet
2 participants
@eschnett
Copy link
Contributor

commented Sep 26, 2013

I have looked at http://stellar.cct.lsu.edu/files/hpx_0.9.6/html/hpx/manual/init/logging.html, and I find this page is quite confusing. It discusses the "init file format" and even points to another page describing this, without saying what file this or where it should be located.

The table with logging levels and "integral values" is also strange. Presumably, one has to set an environment variable to the particular integral value to set the respective logging level.

The page speaks of "environmental variables in the main HPX ini file". I assume I can just set an environment variable for this, without knowing where this "main HPX ini file" is located or how to create it. This should be stated explicitly.

The statement "the syntax and means of setting environment variables varies between operating systems" is not helpful. The two main Unix syntaxes (sh and csh, via "export var=value" and "setenv var value" could be mentioned here, or there could be pointers to other places describing this.

I assume that you will be asking users to switch on logging to help them debug problems. In this case, it should be most useful to have an example there.

@ghost ghost assigned hkaiser Sep 26, 2013

@hkaiser

This comment has been minimized.

Copy link
Member

commented Sep 26, 2013

Ok. You looked at the wrong place, though. Logging is enabled by a simple --hpx:debug-hpx-log on the command line. By default it goes to the console. You can specify a filename as well: --hpx:debug-hpx-log=<file>.

@hkaiser hkaiser closed this in 226b58d Oct 1, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.