am f33f1941: Docs: Adding 4.3R2 CTS to Downloads page in master Staging location: http://claym.mtv.corp.google.com:8085/compatibility/downloads.html
* commit 'f33f194105296b0acdc700c06afc49b9d011140c':
Docs: Adding 4.3R2 CTS to Downloads page in master Staging location: http://claym.mtv.corp.google.com:8085/compatibility/downloads.html
diff --git a/README b/README
index cb443f0..08a3bdf 100644
--- a/README
+++ b/README
@@ -1,80 +1,83 @@
-# HOW TO BUILD SOURCE.ANDROID.COM #
+# HOW TO UPDATE SOURCE.ANDROID.COM #
-source.android.com contains tutorials, references, and miscellaneous
-information relating to the Android Open Source Project (AOSP). The current
-iteration of this site is fully static HTML (notably lacking in javascript and
-doxygen content), and is and/or was maintained by skyler (illustrious intern
-under Dan Morrill and assistant to the almighty JBQ).
+The source.android.com site contains tutorials, references, and other
+information related to the Android Open Source Project (AOSP). The rendered
+output of this site is static HTML, although the source contents are stored
+in Javadoc. Conduct your edits in the Javadoc (.jd files).
-## Short Instructions ##
+Note that the currently viewable docs at http://source.android.com/
+are not necessarily exactly in sync with the doc sources you can download from
+AOSP. If you want to make a contribution to the doc sources, please check in at
+android-contrib@ group. That way, we can make sure the affected docs are stable
+before you upload your CL.
-Run the build script, from the same directory as this file:
+### File Location ###
- python scripts/build.py
+The source.android.com source files are stored in the platform/docs/source.android.com/
+Android project:
+https://android.googlesource.com/platform/docs/source.android.com/
-This generates the directory ./out, which is the fully built site. Hoorah.
+The files to be edited are located in: <root>/docs/source.android.com/src
-The included scripts/micro-httpd.py script is helpful for testing the site on
-your own machine. Running it will start up a tiny HTTP server that you can hit
-to test changes in a browser:
+Every .jd file under src/ is an individual page in Javadoc format. This format
+closely resembles HTML with different headers.
- cd ./out
- HTTP_PORT=8080 python ../scripts/micro-httpd.py
+Subdirectories exist for the tabs of source.android.com with their structure
+roughly (but not identically) mirroring navigation of the site.
-### Markdown ###
-Markdown is a very simple markup format for plain-text that converts it to
-decent HTML. Useful docs:
-http://daringfireball.net/projects/markdown/syntax
-
-Yes, it was created by John Gruber himself. BWAHAHA!
+In addition, each tab and subdirectory contains a *_toc.cs file (such as
+devices_toc.cs) that defines the navigation for that section of the site. When
+pages are added or removed, the corresponding *_toc.cs file must be updated to
+match.
### Dependencies ###
-You need the Python markdown implementation. The original Perl impl probably
-will NOT work.
+ - Vi, Emacs or another plain-text editor
+ - Python
+ - App Engine - https://developers.google.com/appengine/
+ - An app.yaml configuration file placed in the root of the
+ out/target/common/docs/online-sac directory with these contents:
+ -----
+ application: NAMEOFYOURAPP
+ version: 1
+ runtime: python
+ api_version: 1
-For (Goo|U)buntu:
-% sudo apt-get install python-markdown
+ handlers:
+ - url: /
+ static_dir: /
+ -----
-For Mac:
-$ sudo easy_install ElementTree
-$ sudo easy_install Markdown
+## Edit Instructions ##
-More information here:
-http://www.freewisdom.org/projects/python-markdown/Installation
+1. Initialize the repository and download the Android source per:
+http://source.android.com/source/downloading.html
-### Contents Included in Box ###
+2. Start a temporary branch for your changes, such as:
+http://source.android.com/source/using-repo.html#start
-Necessary source files include:
+3. Edit the Javadoc file(s) and save your changes.
- src/ individual page content in markdown format
- templates/ templates for page content
+4. If a page was added or removed, update the corresponding *.toc.cs file to
+reflect the change.
-and the following content which is copied directly:
+5. Run the following make command from the root of the project parent directory:
- assets/ stylish things that make the page look pretty
- images/ exactly what it sounds like
+ make online-sac-docs
-### Structure of Site Source ###
+This generates the output in:
+<root>/out/target/common/docs/online-sac
-The build script assumes that
-- Every .md file under src/ is an individual page in markdown format.
-- Each directory under src/ is a tab of source.android.com and contains its
- particular sidebar. Note, the sidebar in the root of site_src/ itself is
- present but empty.
-- Please use .md if possible (because this will pick up the global site CSS
- and layout.) But the build.py script will indeed copy arbitrary files to the
- output dir, so it is possible to simply place .html, .pdf, and similar files
- to the src/ tree and they will be copied directly to ./out.
+6. Start App Engine and point it at the output directory, like so:
+ python /bin/google_appengine/dev_appserver.py \
+ /master/out/target/common/docs/online-sac \
+ --address 0.0.0.0 --port 8080 &
-# HOW TO PUSH SOURCE.ANDROID.COM TO PROD #
-Coming soon. For now, harass morrildl, jbq, and/or btmura.
+7. Review your changes at localhost:8080/index.html
+8. Once satisfied, submit the changes as described at:
+http://source.android.com/source/submit-patches.html
-# SORDID HISTORY OF SOURCE.ANDROID.COM #
+Your change will be routed to the source.android.com team for inclusion.
-Once upon a time, source.android.com used to be a site on Sites.
-Then it was rewritten to use the developer SDK docs, but this was hard to edit
-and overkill.
-Now it is as you see it.
diff --git a/src/source/downloading.jd b/src/source/downloading.jd
index 6d4212e..e4dd24b 100644
--- a/src/source/downloading.jd
+++ b/src/source/downloading.jd
@@ -55,7 +55,7 @@
Download the Repo tool and ensure that it is executable:
</p>
<pre>
-$ curl https://dl-ssl.google.com/dl/googlesource/git-repo/repo > ~/bin/repo
+$ curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
$ chmod a+x ~/bin/repo
</pre>
</li>
@@ -66,6 +66,9 @@
<p>
For version 1.19, the SHA-1 checksum for repo is 92cbad8c880f697b58ed83e348d06619f8098e6c
</p>
+<p>
+ For version 1.20, the SHA-1 checksum for repo is e197cb48ff4ddda4d11f23940d316e323b29671c
+</p>
<h2 id="initializing-a-repo-client">
Initializing a Repo client
</h2>
@@ -279,4 +282,4 @@
<p>
If you haven't <a href="initializing.html#ccache">set up ccache</a> yet, now would be a good
time to do it.
-</p>
\ No newline at end of file
+</p>
diff --git a/src/source/initializing.jd b/src/source/initializing.jd
index 42448ac..e3d77f0 100644
--- a/src/source/initializing.jd
+++ b/src/source/initializing.jd
@@ -81,10 +81,21 @@
</code></pre>
<p><em>Note: The <code>lunch</code> command in the build step will ensure that the Sun JDK is
used instead of any previously installed JDK.</em></p>
+
+<h2 id="installing-required-packages-ubuntu-1204">Installing required packages (Ubuntu 12.04)</h2>
+<p>You will need a 64-bit version of Ubuntu. Ubuntu 12.04 is recommended.
+Building using an older version of Ubuntu is not supported on master or recent releases.</p>
+<pre><code>$ sudo apt-get install git gnupg flex bison gperf build-essential \
+ zip curl libc6-dev libncurses5-dev:i386 x11proto-core-dev \
+ libx11-dev:i386 libreadline6-dev:i386 libgl1-mesa-glx:i386 \
+ libgl1-mesa-dev g++-multilib mingw32 tofrodos \
+ python-markdown libxml2-utils xsltproc zlib1g-dev:i386
+$ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so
+</code></pre>
+
<h2 id="installing-required-packages-ubuntu-1004-1110">Installing required packages (Ubuntu 10.04 -- 11.10)</h2>
-<p>You will need a 64-bit version of Ubuntu. Ubuntu 10.04 is recommended.
-Building using a newer version of Ubuntu is currently only experimentally
-supported and is not guaranteed to work on branches other than master.</p>
+<p>Building on Ubuntu 10.04-11.10 is no longer supported, but may be useful for building older
+releases of AOSP.</p>
<pre><code>$ sudo apt-get install git-core gnupg flex bison gperf build-essential \
zip curl zlib1g-dev libc6-dev lib32ncurses5-dev ia32-libs \
x11proto-core-dev libx11-dev lib32readline5-dev lib32z-dev \
@@ -97,16 +108,6 @@
<p>On Ubuntu 11.10:</p>
<pre><code>$ sudo apt-get install libx11-dev:i386
</code></pre>
-<h2 id="installing-required-packages-ubuntu-1204">Installing required packages (Ubuntu 12.04)</h2>
-<p>Building on Ubuntu 12.04 is currently only experimentally supported and is not
-guaranteed to work on branches other than master.</p>
-<pre><code>$ sudo apt-get install git gnupg flex bison gperf build-essential \
- zip curl libc6-dev libncurses5-dev:i386 x11proto-core-dev \
- libx11-dev:i386 libreadline6-dev:i386 libgl1-mesa-glx:i386 \
- libgl1-mesa-dev g++-multilib mingw32 tofrodos \
- python-markdown libxml2-utils xsltproc zlib1g-dev:i386
-$ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so
-</code></pre>
<h2 id="configuring-usb-access">Configuring USB Access</h2>
<p>Under GNU/linux systems (and specifically under Ubuntu systems),
regular users can't directly access USB devices by default. The
@@ -134,6 +135,8 @@
SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e30", MODE="0600", OWNER="<username>"
# adb protocol on panda (PandaBoard)
SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d101", MODE="0600", OWNER="<username>"
+# adb protocol on panda (PandaBoard ES)
+SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="d002", MODE="0600", OWNER="<username>"
# fastboot protocol on panda (PandaBoard)
SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d022", MODE="0600", OWNER="<username>"
# usbboot protocol on panda (PandaBoard)
@@ -231,6 +234,10 @@
<p>Once mounted, you'll do all your work in the "android" volume. You can eject it (unmount it) just like you would with an external drive.</p>
<h2 id="master-branch">Master branch</h2>
<p>To build the latest source in a Mac OS environment, you will need an Intel/x86
+machine running MacOS 10.8 (Mountain Lion), along with Xcode
+4.5.2 and Command Line Tools.</p>
+<h2 id="branch-40x-and-all-earlier-branches">Branch 4.2.x and earlier branches</h2>
+<p>To build 4.2.x and earlier source in a Mac OS environment, you will need an Intel/x86
machine running MacOS 10.6 (Snow Leopard) or MacOS 10.7 (Lion), along with Xcode
4.2 (Apple's Developer Tools). Although Lion does not come with a JDK, it should
install automatically when you attempt to build the source.</p>
@@ -300,4 +307,4 @@
ulimit -S -n 1024
</code></pre>
<h1 id="next-download-the-source">Next: Download the source</h1>
-<p>Your build environment is good to go! Proceed to <a href="downloading.html">downloading the source</a>....</p>
\ No newline at end of file
+<p>Your build environment is good to go! Proceed to <a href="downloading.html">downloading the source</a>....</p>