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

Make shell examples copyable in docs #1083

Closed
brycelelbach opened this Issue Mar 22, 2014 · 2 comments

Comments

Projects
None yet
2 participants
@brycelelbach
Member

brycelelbach commented Mar 22, 2014

In the docs, all examples of commands (to be entered in a shell) should be easy to copy and paste.

As an example:

http://stellar-group.github.io/hpx/docs/html/hpx/tutorial/getting_started/intel_mic_installation.html

The instructions for building hwloc on that page give this example

$ CC=icc CFLAGS=-mmic CXX=icpc CXXFLAGS=-mmic LDFLAGS=-mmic \
    ./configure --host=k1om --prefix=$HWLOC_ROOT
$ make
$ make install

However, if you select all three of those lines in a web browser, the $'s are selected, and you can't simply paste it into your shell.

@brycelelbach

This comment has been minimized.

Show comment
Hide comment
@brycelelbach

brycelelbach Mar 22, 2014

Member

Fixed, but I'm gonna leave this open. Hartmut, please close once you've read this (most of these were from you - going forward I think it'd be good if we could try to avoid adding the $).

Member

brycelelbach commented Mar 22, 2014

Fixed, but I'm gonna leave this open. Hartmut, please close once you've read this (most of these were from you - going forward I think it'd be good if we could try to avoid adding the $).

brycelelbach added a commit that referenced this issue Mar 22, 2014

@hkaiser hkaiser added this to the 0.9.9 milestone Mar 22, 2014

@hkaiser

This comment has been minimized.

Show comment
Hide comment
@hkaiser

hkaiser Mar 22, 2014

Member

Good point! However, you forgot to fix README.rst.

Member

hkaiser commented Mar 22, 2014

Good point! However, you forgot to fix README.rst.

@hkaiser hkaiser closed this in a139441 Mar 22, 2014

@hkaiser hkaiser modified the milestones: 0.9.8, 0.9.9 Mar 24, 2014

@hkaiser hkaiser modified the milestones: 0.9.9, 0.9.8 Mar 31, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment