[llvm-commits] [llvm] r165632 - /llvm/trunk/docs/GettingStarted.rst

Wed Oct 10 10:13:13 PDT 2012

Looks like this fixed it.

-- Sean Silva

On Wed, Oct 10, 2012 at 1:07 PM, Sean Silva <silvas at purdue.edu> wrote:
> Author: silvas
> Date: Wed Oct 10 12:07:23 2012
> New Revision: 165632
>
> URL: http://llvm.org/viewvc/llvm-project?rev=165632&view=rev
> Log:
> docs: Attempt to fix PR14053.
>
> Hypothesis 1: use of `.. code::` directive instead of `.. code-block::`
> is causing Sphinx to discard the block. On my machine, `.. code::`
> renders fine. However, I don't think that `..  code::` is actually a
> legit Sphinx directive. I believe that on my machine Sphinx is falling
> back to just displaying it monospace with no syntax, whereas llvm.org's
> Sphinx is just discarding it.
>
> This is truly "remote debugging" since I can't reproduce this on my
> machine. It would be helpful to be able to see the llvm.org Sphinx
> build logs; if that's possible please let me know.
>
> Modified:
>     llvm/trunk/docs/GettingStarted.rst
>
> Modified: llvm/trunk/docs/GettingStarted.rst
> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=165632&r1=165631&r2=165632&view=diff
> ==============================================================================
> --- llvm/trunk/docs/GettingStarted.rst (original)
> +++ llvm/trunk/docs/GettingStarted.rst Wed Oct 10 12:07:23 2012
> @@ -505,7 +505,7 @@
>  If you would like to get the LLVM test suite (a separate package as of 1.4), you
>  get it from the Subversion repository:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % cd llvm/projects
>    % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
> @@ -523,13 +523,13 @@
>  mirrors reflect only ``trunk`` for each project. You can do the read-only GIT
>  clone of LLVM via:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git clone http://llvm.org/git/llvm.git
>
>  If you want to check out clang too, run:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git clone http://llvm.org/git/llvm.git
>    % cd llvm/tools
> @@ -540,7 +540,7 @@
>  in your clone.  To configure ``git pull`` to pass ``--rebase`` by default on the
>  master branch, run the following command:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git config branch.master.rebase true
>
> @@ -553,13 +553,13 @@
>  branch, and ``mybranch`` is rebased onto ``master``.  At first you may check
>  sanity of whitespaces:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git diff --check master..mybranch
>
>  The easiest way to generate a patch is as below:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git diff master..mybranch > /path/to/mybranch.diff
>
> @@ -570,20 +570,20 @@
>  But you may generate patchset with git-format-patch. It generates by-each-commit
>  patchset. To generate patch files to attach to your article:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git format-patch --no-attach master..mybranch -o /path/to/your/patchset
>
>  If you would like to send patches directly, you may use git-send-email or
>  git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git format-patch --attach master..mybranch --stdout | git imap-send
>
>  Then, your .git/config should have [imap] sections.
>
> -.. code:: bash
> +.. code-block:: bash
>
>    [imap]
>          host = imaps://imap.gmail.com
> @@ -603,7 +603,7 @@
>
>  To set up clone from which you can submit code using ``git-svn``, run:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git clone http://llvm.org/git/llvm.git
>    % cd llvm
> @@ -622,7 +622,7 @@
>  To update this clone without generating git-svn tags that conflict with the
>  upstream git repo, run:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % git fetch && (cd tools/clang && git fetch)  # Get matching revisions of both trees.
>    % git checkout master
> @@ -640,7 +640,7 @@
>  ``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
>  about files with uncommitted changes. The fix is to rebuild the metadata:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % rm -rf .git/svn
>    % git svn rebase -l
> @@ -722,13 +722,13 @@
>
>  #. Change directory into the object root directory:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % cd OBJ_ROOT
>
>  #. Run the ``configure`` script located in the LLVM source tree:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % SRC_ROOT/configure --prefix=/install/path [other options]
>
> @@ -764,7 +764,7 @@
>  Once you have LLVM configured, you can build it by entering the *OBJ_ROOT*
>  directory and issuing the following command:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % gmake
>
> @@ -775,7 +775,7 @@
>  parallel build options provided by GNU Make.  For example, you could use the
>  command:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % gmake -j2
>
> @@ -866,13 +866,13 @@
>
>  * Change directory to where the LLVM object files should live:
>
> -  .. code:: bash
> +  .. code-block:: bash
>
>      % cd OBJ_ROOT
>
>  * Run the ``configure`` script found in the LLVM source directory:
>
> -  .. code:: bash
> +  .. code-block:: bash
>
>      % SRC_ROOT/configure
>
> @@ -918,7 +918,7 @@
>  execute LLVM bitcode files directly. To do this, use commands like this (the
>  first command may not be required if you are already using the module):
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
>    % echo ':llvm:M::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
> @@ -928,7 +928,7 @@
>  This allows you to execute LLVM bitcode files directly.  On Debian, you can also
>  use this command instead of the 'echo' command above:
>
> -.. code:: bash
> +.. code-block:: bash
>
>    % sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
>
> @@ -1208,7 +1208,7 @@
>
>  #. First, create a simple C file, name it 'hello.c':
>
> -   .. code:: c
> +   .. code-block:: c
>
>       #include <stdio.h>
>
> @@ -1219,7 +1219,7 @@
>
>  #. Next, compile the C file into a native executable:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % clang hello.c -o hello
>
> @@ -1230,7 +1230,7 @@
>
>  #. Next, compile the C file into a LLVM bitcode file:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % clang -O3 -emit-llvm hello.c -c -o hello.bc
>
> @@ -1240,13 +1240,13 @@
>
>  #. Run the program in both forms. To run the program, use:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>        % ./hello
>
>     and
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % lli hello.bc
>
> @@ -1255,19 +1255,19 @@
>
>  #. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % llvm-dis < hello.bc | less
>
>  #. Compile the program to native assembly using the LLC code generator:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % llc hello.bc -o hello.s
>
>  #. Assemble the native assembly language file into a program:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       **Solaris:** % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native
>
> @@ -1275,7 +1275,7 @@
>
>  #. Execute the native code program:
>
> -   .. code:: bash
> +   .. code-block:: bash
>
>       % ./hello.native
>
>
>
> _______________________________________________
> llvm-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits