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

Update Compiling.rst #3289

Merged
merged 3 commits into from
Feb 21, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 22 additions & 17 deletions doc/release/compiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ variables are listed by the ``--help-env`` option. The flags' current
settings are listed by ``--help-settings``.

More detailed information about the compiler and its command-line
flags is also available on its man page, which you can read using:
flags is also available on its :any:`man page <man>`, which can be viewed from
the command-line using:

.. code-block:: sh

Expand All @@ -46,33 +47,37 @@ Most Useful Flags

We note some of the most useful flags here:

-o <filename> specify the filename of the generated
===================== ======================================================
Flags Description
--------------------- ------------------------------------------------------
``-o <filename>`` specify the filename of the generated
executable, otherwise ./a.out is used by default
--no-checks turns off runtime semantic checks like bounds
``--no-checks`` turns off runtime semantic checks like bounds
checking and nil class instance dereferencing
-O turns on optimization of the generated C code
--fast turns on ``--no-checks``, ``-O``, and enables
``-O`` turns on optimization of the generated C code
``--fast`` turns on ``--no-checks``, ``-O``, and enables
many other optimizations
--savec <dir> saves the generated C code in the specified
``--savec <dir>`` saves the generated C code in the specified
directory
-g support debugging of the generated C code
--ccflags <flags> specify flags that should be used when invoking
``-g`` support debugging of the generated C code
``--ccflags <flags>`` specify flags that should be used when invoking
the back-end C compiler
--ldflags <flags> specify flags that should be used when invoking
``--ldflags <flags>`` specify flags that should be used when invoking
the back-end linker
-s <name[=expr]> set a config variable with the given expression
``-s <name[=expr]>`` set a config variable with the given expression
as its default value (config params must be set
to values that are known at compile time)
--print-passes print the compiler passes as they execute
--print-commands print the system commands that the compiler
``--print-passes`` print the compiler passes as they execute
``--print-commands`` print the system commands that the compiler
executes
--print-code-size prints some code size statistics about the
``--print-code-size`` prints some code size statistics about the
number of lexical tokens per line, as well as
the number of code, comment, and blank lines
--version print the Chapel compiler version number
--help print a brief overview of the command-line
``--version`` print the Chapel compiler version number
``--help`` print a brief overview of the command-line
options
--help-env lists the environment variables for each
``--help-env`` lists the environment variables for each
command-line flag
--help-settings lists the current setting of each command-line
``--help-settings`` lists the current setting of each command-line
flag
===================== ======================================================
7 changes: 4 additions & 3 deletions doc/release/technotes/dsi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@ class that chooses to support privatization.
Returns `true` to indicate that privatization is supported.
NOTE: do not specify the return type (due to a bug in the compiler).


.. code-block:: chapel

class Global ... {
Expand All @@ -775,9 +776,9 @@ class that chooses to support privatization.
...
}

The field ``pid`` should be provided as shown.
It should not be accessed by the DSI implementation except
in conjunction with ``chpl_getPrivatizedCopy()`` as discussed later.
The field ``pid`` should be provided as shown.
It should not be accessed by the DSI implementation except
in conjunction with ``chpl_getPrivatizedCopy()`` as discussed later.

.. method:: proc Global.dsiGetPrivatizeData()

Expand Down
10 changes: 5 additions & 5 deletions doc/release/technotes/subquery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ hasSingleLocalSubdomain

.. code-block:: chapel

proc [].hasSingleLocalSubdomain() : bool;
proc array.hasSingleLocalSubdomain() : bool;

This is a param function which returns a boolean. If true, then the index set
owned by a locale can be represented by a single domain.
Expand All @@ -45,7 +45,7 @@ localSubdomain

.. code-block:: chapel

proc [].localSubdomain() : domain;
proc array.localSubdomain() : domain;

This function only operates on arrays whose 'hasSingleLocalSubdomain()' result
is true. Otherwise, a compiler error is thrown.
Expand All @@ -65,7 +65,7 @@ localSubdomains

.. code-block:: chapel

iter [].localSubdomains() : domain;
iter array.localSubdomains() : domain;

This iterator yields the subdomain(s) that represent the index set owned by the
current locale.
Expand All @@ -74,7 +74,7 @@ If the locale's index set can be represented by a single domain, then the
result of ``localSubdomain`` is yielded.

Currently, this is a serial iterator.

To support this iterator on a custom distributed array type, write an iterator
named 'dsiLocalSubdomains'.

Expand All @@ -89,7 +89,7 @@ targetLocales

.. code-block:: chapel

proc [].targetLocales() : [] locale;
proc array.targetLocales() : [] locale;

This function returns an array of locales that the distribution uses as the
locale grid.
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/source/language/evolution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ Emacs users working on updating existing code can use the following recipe
to update old-style domain literals to the new syntax:


.. code-block:: chapel
.. code-block:: text

M-x query-replace-regexp: \([=|,] *\)\[\(.*?\)\]\([;|)]\)
with: \1{\2}\3
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/source/usingchapel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Contents:
chplenv
building
compiling
Chapel Man Page <man>
executing
multilocale
launcher
tasks
debugging
bugs
Man Page <man>