From a947fce312fb0670ed4e5a486cf9dbd226baa948 Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Fri, 26 Mar 2010 16:32:02 -0700 Subject: [PATCH] cherry-pick fda3521ea37b53c1dc633c39845e4e8f25c3234f into froyo Conflicts: docs/html/sdk/ndk/1.5_r1/index.jd Change-Id: I19f6e97bd019ac347a34db0aea157a33d0217189 --- docs/html/sdk/ndk/1.5_r1/index.jd | 337 +-------------------- docs/html/sdk/ndk/1.6_r1/index.jd | 361 +--------------------- docs/html/sdk/ndk/index.jd | 477 ++++++++++++++++++++++++++++++ docs/html/sdk/sdk_toc.cs | 3 +- 4 files changed, 485 insertions(+), 693 deletions(-) create mode 100644 docs/html/sdk/ndk/index.jd diff --git a/docs/html/sdk/ndk/1.5_r1/index.jd b/docs/html/sdk/ndk/1.5_r1/index.jd index 16d543d2efb76..4c70a8a6f91ec 100644 --- a/docs/html/sdk/ndk/1.5_r1/index.jd +++ b/docs/html/sdk/ndk/1.5_r1/index.jd @@ -1,337 +1,6 @@ -ndk=true -ndk.version=1.5 -ndk.rel.id=1 -ndk.date=June 2009 - -ndk.win_download=android-ndk-1.5_r1-windows.zip -ndk.win_bytes=22500667 -ndk.win_checksum=e5c53915903d8b81f3e2ea422e2e2717 - -ndk.mac_download=android-ndk-1.5_r1-darwin-x86.zip -ndk.mac_bytes=17215303 -ndk.mac_checksum=1931f0e182798a4c98924fd87380b5b8 - -ndk.linux_download=android-ndk-1.5_r1-linux-x86.zip -ndk.linux_bytes=16025885 -ndk.linux_checksum=80a4e14704ca84c21bf1824cb25fbd8b - page.title=Android 1.5 NDK, Release 1 +sdk.redirect=true +sdk.redirect.path=ndk/index.html + @jd:body -

What is the Android NDK?

- -

The Android NDK provides tools that allow Android application developers -to embed components that make use of native code in their Android applications. -

- -

Android applications run in the Dalvik virtual machine. The NDK allows -developers to implement parts of their applications using native-code languages -such as C and C++. This can provide benefits to certain classes of applications, -in the form of reuse of existing code and in some cases increased speed.

- -

The NDK provides:

- - - -

This release of the NDK supports the ARMv5TE machine instruction set -and provides stable headers for libc (the C library), libm (the Math library), -the JNI interface, and other libraries.

- -

The NDK will not benefit most applications. As a developer, you will need -to balance its benefits against its drawbacks; notably, using native code does -not result in an automatic performance increase, but does always increase -application complexity. Typical good candidates for the NDK are self-contained, -CPU-intensive operations that don't allocate much memory, such as signal processing, -physics simulation, and so on. Simply re-coding a method to run in C usually does -not result in a large performance increase. The NDK can, however, can be -an effective way to reuse a large corpus of existing C/C++ code.

- -

Please note that the NDK does not enable you to develop native-only -applications. Android's primary runtime remains the Dalvik virtual machine.

- -

Contents of the NDK

- -

Development tools

- -

The NDK includes a set of cross-toolchains (compilers, linkers, etc..) that -can generate native ARM binaries on Linux, OS X, and Windows (with Cygwin) -platforms.

- -

It provides a set of system headers for stable native APIs that are -guaranteed to be supported in all later releases of the platform:

- - - -

The NDK also provides a build system that lets you work efficiently with your -sources, without having to handle the toolchain/platform/CPU/ABI details. You -create very short build files to describe which sources to compile and which -Android application will use them — the build system compiles the sources -and places the shared libraries directly in your application project.

- -

Important: With the exception of the -libraries listed above, native system libraries in the Android 1.5 platform are -not stable and may change in future platform versions. -Your applications should only make use of the stable native system -libraries provided in this NDK.

- -

Documentation

- -

The NDK package includes a set of documentation that describes the -capabilities of the NDK and how to use it to create shared libraries for your -Android applications. In this release, the documentation is provided only in the -downloadable NDK package. You can find the documentation in the -<ndk>/docs/ directory. Included are these files:

- - - -

Additionally, the package includes detailed information about the "bionic" -C library provided with the Android platform that you should be aware of, if you -are developing using the NDK. You can find the documentation in the -<ndk>/docs/system/libc/ directory:

- - - -

Sample applications

- -

The NDK includes two sample Android applications that illustrate how to use -native code in your Android applications:

- - - -

For more information, see Using the Sample -Applications.

- -

System and Software Requirements

- -

The sections below describe the system and software requirements for using -the Android NDK, as well as platform compatibility considerations that affect -applications using libraries produced with the NDK.

- -

The Android SDK

- - -

Supported operating systems

- - -

Required development tools

- - -

Android platform compatibility

- - -

Installing the NDK

- -

Installing the NDK on your development computer is straightforward and -involves extracting the NDK from its download package and running a host-setup -script.

- -

Before you get started make sure that you have downloaded the latest Android SDK and upgraded your applications -and environment as needed. The NDK will not work with older versions of the -Android SDK. Also, take a moment to review the System -and Software Requirements for the NDK, if you haven't already.

- -

To install the NDK, follow these steps:

- -
    -
  1. From the table at the top of this page, select the NDK package that is -appropriate for your development computer and download the package.
    2. -
  2. Uncompress the NDK download package using tools available on your computer. -When uncompressed, the NDK files are contained in a directory called -android-ndk-<version>. You can rename the NDK directory if -necessary and you can move it to any location on your computer. This -documentation refers to the NDK directory as <ndk>.
    3. -
  3. Open a terminal, change to the NDK directory, and run the host-setup script. -The script sets up your environment and generates a host configuration file used -later, when building your shared libraries. The path to the host-setup script -is: - -

    <ndk>/build/host-setup.sh

    - -

    If the script completes successfully, it prints a "Host setup complete." -message. If it fails, it prints instructions that you can follow to correct any -problems.

    -
    4. -
- -

Once you have run the host-setup script, you are ready start working with the -NDK.

- -

Getting Started with the NDK

- -

Once you've installed the NDK successfully, take a few minutes to read the -documentation included in the NDK. You can find the documentation in the -<ndk>/docs/ directory. In particular, please read the -OVERVIEW.TXT document completely, so that you understand the intent of the NDK -and how to use it.

- -

Here's the general outline of how you work with the NDK tools:

- -
    -
  1. Place your native sources under -<ndk>/sources/<my_src>/.... If you want, you can place -a symlink to your sources, rather than the sources themselves. The sources you -reference here are not strictly associated with a specific shared library or -Android application. Instead, they are accessible to any build configuration and -can be used to produce any number of shared libraries that can be used by any -Android application.
    2. -
  2. Create <ndk>/sources/<my_src>/Android.mk to -describe your native sources to the NDK build system
    3. -
  3. Create <ndk>/apps/<my_app>/Application.mk to -describe your Android application and native sources it needs to the NDK build -system. This file sets up the link between an Android SDK application project -and any number of shared libraries defined in the -<ndk>/sources/ folder and it specifies the path to the -application project that will receive the shared library built from the -sources.
    4. -
  4. Build your native code by running this make command from the top-level NDK -directory: - -

    $ make APP=<my_app>

    - -

    The build tools copy the stripped, shared libraries needed by your -application to the proper location in the application's project directory.

    -
    5. - -
  5. Finally, compile your application using the SDK tools in the usual way. The -SDK build tools will package the shared libraries in the application's -deployable .apk file.

    6. - -
- -

For complete information on all of the steps listed above, please see the -documentation included with the NDK package.

- - -

Using the Sample Applications

- -

The NDK includes two sample applications that illustrate how to use native -code in your Android applications:

- - - -

For each sample, the NDK includes an Android application project, as well as -the corresponding C source code and the necessary Android.mk and Application.mk -files. The application projects are provided in -<ndk>/apps/<app_name>/project/ and the C source for -each application is provided in -<ndk>/sources/samples/<library>/.

- -

Once you have installed the NDK, you can build the shared libraries from the -NDK by using these commands from the root of the NDK directory:

- - -

Next, build the sample Android applications that use the shared -libraries:

- - - -

Discussion Forum and Mailing List

- -

If you have questions about the NDK or would like to read or contribute to -discussions about it, please visit the android-ndk group and -mailing list.

- - diff --git a/docs/html/sdk/ndk/1.6_r1/index.jd b/docs/html/sdk/ndk/1.6_r1/index.jd index e066f9589b86b..090dcdc378672 100644 --- a/docs/html/sdk/ndk/1.6_r1/index.jd +++ b/docs/html/sdk/ndk/1.6_r1/index.jd @@ -1,360 +1,5 @@ -ndk=true -ndk.version=1.6 -ndk.rel.id=1 -ndk.date=September 2009 - -ndk.win_download=android-ndk-1.6_r1-windows.zip -ndk.win_bytes=25896444 -ndk.win_checksum=a213c9592f24c61620755c6c43f85210 - -ndk.mac_download=android-ndk-1.6_r1-darwin-x86.zip -ndk.mac_bytes=20611080 -ndk.mac_checksum=93c5b8b92a1f7b1cdadf267cab8ec403 - -ndk.linux_download=android-ndk-1.6_r1-linux-x86.zip -ndk.linux_bytes=19421662 -ndk.linux_checksum=464d3dc02739b82917e6f0591e17edd1 - page.title=Android 1.6 NDK, Release 1 +sdk.redirect=true +sdk.redirect.path=ndk/index.html + @jd:body - -

What is the Android NDK?

- -

The Android NDK provides tools that allow Android application developers -to embed components that make use of native code in their Android applications. -

- -

Android applications run in the Dalvik virtual machine. The NDK allows -developers to implement parts of their applications using native-code languages -such as C and C++. This can provide benefits to certain classes of applications, -in the form of reuse of existing code and in some cases increased speed.

- -

The NDK provides:

- - - -

This release of the NDK supports the ARMv5TE machine instruction set -and provides stable headers for libc (the C library), libm (the Math library), -OpenGL ES 1.1 (3D graphics library), the JNI interface, and other libraries.

- -

The NDK will not benefit most applications. As a developer, you will need -to balance its benefits against its drawbacks; notably, using native code does -not result in an automatic performance increase, but does always increase -application complexity. Typical good candidates for the NDK are self-contained, -CPU-intensive operations that don't allocate much memory, such as signal processing, -physics simulation, and so on. Simply re-coding a method to run in C usually does -not result in a large performance increase. The NDK can, however, can be -an effective way to reuse a large corpus of existing C/C++ code.

- -

Please note that the NDK does not enable you to develop native-only -applications. Android's primary runtime remains the Dalvik virtual machine.

- -

Contents of the NDK

- -

Development tools

- -

The NDK includes a set of cross-toolchains (compilers, linkers, etc..) that -can generate native ARM binaries on Linux, OS X, and Windows (with Cygwin) -platforms.

- -

It provides a set of system headers for stable native APIs that are -guaranteed to be supported in all later releases of the platform:

- - - -

The NDK also provides a build system that lets you work efficiently with your -sources, without having to handle the toolchain/platform/CPU/ABI details. You -create very short build files to describe which sources to compile and which -Android application will use them — the build system compiles the sources -and places the shared libraries directly in your application project.

- -

Important: With the exception of the -libraries listed above, native system libraries in the Android platform are -not stable and may change in future platform versions. -Your applications should only make use of the stable native system -libraries provided in this NDK.

- -

Documentation

- -

The NDK package includes a set of documentation that describes the -capabilities of the NDK and how to use it to create shared libraries for your -Android applications. In this release, the documentation is provided only in the -downloadable NDK package. You can find the documentation in the -<ndk>/docs/ directory. Included are these files:

- - - -

Additionally, the package includes detailed information about the "bionic" -C library provided with the Android platform that you should be aware of, if you -are developing using the NDK. You can find the documentation in the -<ndk>/docs/system/libc/ directory:

- - - -

Sample applications

- -

The NDK includes three sample Android applications that illustrate how to use -native code in your Android applications:

- - - -

For more information, see Using the Sample -Applications.

- -

System and Software Requirements

- -

The sections below describe the system and software requirements for using -the Android NDK, as well as platform compatibility considerations that affect -appplications using libraries produced with the NDK.

- -

The Android SDK

- - -

Supported operating systems

- - -

Required development tools

- - -

Android platform compatibility

- - -

Installing the NDK

- -

Installing the NDK on your development computer is straightforward and -involves extracting the NDK from its download package and running a host-setup -script.

- -

Before you get started make sure that you have downloaded the latest Android SDK and upgraded your applications -and environment as needed. The NDK will not work with older versions of the -Android SDK. Also, take a moment to review the System -and Software Requirements for the NDK, if you haven't already.

- -

To install the NDK, follow these steps:

- -
    -
  1. From the table at the top of this page, select the NDK package that is -appropriate for your development computer and download the package.
    2. -
  2. Uncompress the NDK download package using tools available on your computer. -When uncompressed, the NDK files are contained in a directory called -android-ndk-<version>. You can rename the NDK directory if -necessary and you can move it to any location on your computer. This -documentation refers to the NDK directory as <ndk>.
    3. -
  3. Open a terminal, change to the NDK directory, and run the host-setup script. -The script sets up your environment and generates a host configuration file used -later, when building your shared libraries. The path to the host-setup script -is: - -

    <ndk>/build/host-setup.sh

    - -

    If the script completes successfully, it prints a "Host setup complete." -message. If it fails, it prints instructions that you can follow to correct any -problems.

    -
    4. -
- -

Once you have run the host-setup script, you are ready start working with the -NDK.

- -

Getting Started with the NDK

- -

Once you've installed the NDK successfully, take a few minutes to read the -documentation included in the NDK. You can find the documentation in the -<ndk>/docs/ directory. In particular, please read the -OVERVIEW.TXT document completely, so that you understand the intent of the NDK -and how to use it.

- -

If you used a previous version of the NDK, take a moment to review the -list of NDK changes in the CHANGES.TXT document.

- -

Here's the general outline of how you work with the NDK tools:

- -
    -
  1. Place your native sources under -<project>/jni/...
    2. -
  2. Create <project>/jni/Android.mk to -describe your native sources to the NDK build system
    3. -
  3. Create <ndk>/apps/<my_app>/Application.mk to -describe your Android application and native sources it needs to the NDK build -system. This file sets up the link between an Android SDK application project -and any number of shared libraries defined in the -<project>/jni/ folder and it specifies the path to the -application project that will receive the shared library built from the -sources.
    4. -
  4. Build your native code by running this make command from the top-level NDK -directory: - -

    $ make APP=<my_app>

    - -

    The build tools copy the stripped, shared libraries needed by your -application to the proper location in the application's project directory.

    -
    5. - -
  5. Finally, compile your application using the SDK tools in the usual way. The -SDK build tools will package the shared libraries in the application's -deployable .apk file.

    6. - -
- -

For complete information on all of the steps listed above, please see the -documentation included with the NDK package.

- - -

Using the Sample Applications

- -

The NDK includes three sample applications that illustrate how to use native -code in your Android applications:

- - - -

For each sample, the NDK includes an Android application project, as well as -the corresponding C source code and the necessary Android.mk and Application.mk -files. The application projects are provided in -<ndk>/apps/<app_name>/project/ and the C source for -each application is provided in -<ndk>/apps/<app_name>/project/jni/.

- -

Once you have installed the NDK, you can build the shared libraries from the -NDK by using these commands from the root of the NDK directory:

- - -

Next, build the sample Android applications that use the shared -libraries:

- - - -

Discussion Forum and Mailing List

- -

If you have questions about the NDK or would like to read or contribute to -discussions about it, please visit the android-ndk group and -mailing list.

- - diff --git a/docs/html/sdk/ndk/index.jd b/docs/html/sdk/ndk/index.jd new file mode 100644 index 0000000000000..fa2e712cf1075 --- /dev/null +++ b/docs/html/sdk/ndk/index.jd @@ -0,0 +1,477 @@ +ndk=true + +ndk.win_download=android-ndk-r3-windows.zip +ndk.win_bytes=36473391 +ndk.win_checksum=4ce5c93a15f261b6dcade1b69da00902 + +ndk.mac_download=android-ndk-r3-darwin-x86.zip +ndk.mac_bytes=38258228 +ndk.mac_checksum=a083ccc36aa9a3a35404861e7d51d1ae + +ndk.linux_download=android-ndk-r3-linux-x86.zip +ndk.linux_bytes=37403241 +ndk.linux_checksum=f3b1700a195aae3a6e9b5637e5c49359 + +page.title=Android NDK +@jd:body + +

Revisions

+ +

The sections below provide information and notes about successive releases of +the NDK, as denoted by revision number.

+ + + + +
+ + +Android NDK, Revision 3 (March 2010) +
+ +
+
General notes:
+ +
+
    +
  • Adds OpenGL ES 2.0 native library support.
    • +
  • Adds a sample application,hello-gl2, that illustrates the use of +OpenGL ES 2.0 vertex and fragment shaders.
    • +
  • The toolchain binaries have been refreshed for this release with GCC 4.4.0, which should generate slightly more compact and efficient machine code than the previous one (4.2.1). The NDK also still provides the 4.2.1 binaries, which you can optionally use to build your machine code.
    • +
+
+
+
+
+ +
+ + +Android NDK, Revision 2 (September 2009) +
+ +

Originally released as "Android 1.6 NDK, Release 1".

+
+
General notes:
+
+
    +
  • Adds OpenGL ES 1.1 native library support.
    • +
  • Adds a sample application, san-angeles, that renders 3D +graphics through the native OpenGL ES APIs, while managing activity +lifecycle with a {@link android.opengl.GLSurfaceView} object. +
    • +
+
+
+
+
+ +
+ + +Android NDK, Revision 1 (June 2009) +
+ +

Originally released as "Android 1.5 NDK, Release 1".

+
+
General notes:
+
+
    +
  • Includes compiler support (GCC) for ARMv5TE instructions, including Thumb-1 +instructions.
    • +
  • Includes system headers for stable native APIs, documentation, and sample +applications.
    • +
+
+ +
+
+
+ + +

What is the Android NDK?

+ +

The Android NDK is a toolset that lets you embed components that make use +of native code in your Android applications. +

+ +

Android applications run in the Dalvik virtual machine. The NDK allows +you to implement parts of your applications using native-code languages +such as C and C++. This can provide benefits to certain classes of applications, +in the form of reuse of existing code and in some cases increased speed.

+ +

The NDK provides:

+ + + +

This release of the NDK supports the ARMv5TE machine instruction set and +provides stable headers for libc (the C library), libm (the Math library), +OpenGL ES (3D graphics library), the JNI interface, and other libraries, as +listed in the section below.

+ +

The NDK will not benefit most applications. As a developer, you will need +to balance its benefits against its drawbacks; notably, using native code does +not result in an automatic performance increase, but does always increase +application complexity. Typical good candidates for the NDK are self-contained, +CPU-intensive operations that don't allocate much memory, such as signal processing, +physics simulation, and so on. Simply re-coding a method to run in C usually does +not result in a large performance increase. The NDK can, however, can be +an effective way to reuse a large corpus of existing C/C++ code.

+ +

Please note that the NDK does not enable you to develop native-only +applications. Android's primary runtime remains the Dalvik virtual machine.

+ +

Contents of the NDK

+ +

Development tools

+ +

The NDK includes a set of cross-toolchains (compilers, linkers, etc..) that +can generate native ARM binaries on Linux, OS X, and Windows (with Cygwin) +platforms.

+ +

It provides a set of system headers for stable native APIs that are +guaranteed to be supported in all later releases of the platform:

+ + + +

The NDK also provides a build system that lets you work efficiently with your +sources, without having to handle the toolchain/platform/CPU/ABI details. You +create very short build files to describe which sources to compile and which +Android application will use them — the build system compiles the sources +and places the shared libraries directly in your application project.

+ +

Important: With the exception of the +libraries listed above, native system libraries in the Android platform are +not stable and may change in future platform versions. +Your applications should only make use of the stable native system +libraries provided in this NDK.

+ +

Documentation

+ +

The NDK package includes a set of documentation that describes the +capabilities of the NDK and how to use it to create shared libraries for your +Android applications. In this release, the documentation is provided only in the +downloadable NDK package. You can find the documentation in the +<ndk>/docs/ directory. Included are these files:

+ + + +

Additionally, the package includes detailed information about the "bionic" +C library provided with the Android platform that you should be aware of, if you +are developing using the NDK. You can find the documentation in the +<ndk>/docs/system/libc/ directory:

+ + + +

Sample applications

+ +

The NDK includes sample Android applications that illustrate how to use +native code in your Android applications. For more information, see +Using the Sample Applications.

+ +

System and Software Requirements

+ +

The sections below describe the system and software requirements for using +the Android NDK, as well as platform compatibility considerations that affect +appplications using libraries produced with the NDK.

+ +

The Android SDK

+ + +

Supported operating systems

+ + +

Required development tools

+ + +

Android platform compatibility

+ + +

Installing the NDK

+ +

Installing the NDK on your development computer is straightforward and +involves extracting the NDK from its download package and running a host-setup +script.

+ +

Before you get started make sure that you have downloaded the latest Android SDK and upgraded your applications +and environment as needed. The NDK will not work with older versions of the +Android SDK. Also, take a moment to review the System +and Software Requirements for the NDK, if you haven't already.

+ +

To install the NDK, follow these steps:

+ +
    +
  1. From the table at the top of this page, select the NDK package that is +appropriate for your development computer and download the package.
    2. +
  2. Uncompress the NDK download package using tools available on your computer. +When uncompressed, the NDK files are contained in a directory called +android-ndk-<version>. You can rename the NDK directory if +necessary and you can move it to any location on your computer. This +documentation refers to the NDK directory as <ndk>.
    3. +
  3. Open a terminal, change to the NDK directory, and run the host-setup script. +The script sets up your environment and generates a host configuration file used +later, when building your shared libraries. The path to the host-setup script +is: + +

    <ndk>/build/host-setup.sh

    + +

    If the script completes successfully, it prints a "Host setup complete." +message. If it fails, it prints instructions that you can follow to correct any +problems.

    +
    4. +
+ +

Once you have run the host-setup script, you are ready start working with the +NDK.

+ +

Getting Started with the NDK

+ +

Once you've installed the NDK successfully, take a few minutes to read the +documentation included in the NDK. You can find the documentation in the +<ndk>/docs/ directory. In particular, please read the +OVERVIEW.TXT document completely, so that you understand the intent of the NDK +and how to use it.

+ +

If you used a previous version of the NDK, take a moment to review the +list of NDK changes in the CHANGES.TXT document.

+ +

Here's the general outline of how you work with the NDK tools:

+ +
    +
  1. Place your native sources under +<project>/jni/...
    2. +
  2. Create <project>/jni/Android.mk to +describe your native sources to the NDK build system
    3. +
  3. Create <ndk>/apps/<my_app>/Application.mk to +describe your Android application and native sources it needs to the NDK build +system. This file sets up the link between an Android SDK application project +and any number of shared libraries defined in the +<project>/jni/ folder and it specifies the path to the +application project that will receive the shared library built from the +sources.
    4. +
  4. Build your native code by running this make command from the top-level NDK +directory: + +

    $ make APP=<my_app>

    + +

    The build tools copy the stripped, shared libraries needed by your +application to the proper location in the application's project directory.

    +
    5. + +
  5. Finally, compile your application using the SDK tools in the usual way. The +SDK build tools will package the shared libraries in the application's +deployable .apk file.

    6. + +
+ +

For complete information on all of the steps listed above, please see the +documentation included with the NDK package.

+ + +

Using the Sample Applications

+ +

The NDK includes four sample applications that illustrate how to use native +code in your Android applications:

+ + + +

For each sample, the NDK includes an Android application project, as well as +the corresponding C source code and the necessary Android.mk and Application.mk +files. The application projects are provided in +<ndk>/apps/<app_name>/project/ and the C source for +each application is provided in +<ndk>/apps/<app_name>/project/jni/.

+ +

Once you have installed the NDK and run $ build/host-setup.sh from +the root of the NDK directory, you can build the shared libraries for the +sample apps by using these commands:

+ + +

Next, build the sample Android applications that use the shared +libraries:

+ + + +

Discussion Forum and Mailing List

+ +

If you have questions about the NDK or would like to read or contribute to +discussions about it, please visit the android-ndk group and +mailing list.

+ + diff --git a/docs/html/sdk/sdk_toc.cs b/docs/html/sdk/sdk_toc.cs index 556f78164241b..b790218819ff1 100644 --- a/docs/html/sdk/sdk_toc.cs +++ b/docs/html/sdk/sdk_toc.cs @@ -126,7 +126,8 @@ Windows, r3 new!