[llvm-commits] [Psuedo-PATCH] Getting Started

[Dmitri Gribenko]

Hello Joe,

On Fri, Nov 30, 2012 at 12:57 AM, Joe Abbey <jabbey at arxan.com> wrote:
> I'm not exactly sure where this should go, but as a starting point I'm putting it inline with the GettingStarted information.  I'm fairly certain the link I've placed to the python script will be broken.  Any suggestions on how to fix that would be much obliged.  As far as I can tell the make -f Makefile.sphinx will only apply to a few filetypes.  As such, the gettingStarted.py script gets left behind, and will not become a part of _build/html.  Do I need to make the patch to www?

I think Makefile.sphinx could be tweaked for this.

Index: gettingStarted.py
===================================================================
--- gettingStarted.py	(revision 0)
+++ gettingStarted.py	(revision 0)

I would call this checkout.py or something like that...

+   * ``./gettingStarted.py``

I think this (and other commands) should be ".. code-block:: bash"
since this is not a list.

+Once the script has finished, please follow instructions for `Configuring and
+Building LLVM and Clang`_ configuring your build.  Alternatively, you
may prefer
+to manually checkout LLVM and its sub-projects.

It would be better to use a named reference here.  The link becomes
:ref:`configuring-and-building`, and before the "Configuring and
Building LLVM and Clang" one places an anchor "..
_configuring-and-building:".

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/