AI 147053: Add -hdf primer vars for the platform and release ID associated with the current (most recent) SDK.
Currently, the docs that are specific to each SDK release -- downloading, installing, upgrading, requirements -- are stored in a directory with release-derived name, such as "1.1_r1". This change lets documents use generic links to point into the most recent version specific docs, eg href="{@docRoot}sdk/{sdkCurrent}/installing.html" instead of href="{@docRoot}sdk/1.1_r1/installing.html".
BUG=1790234
Automated import of CL 147053
diff --git a/Android.mk b/Android.mk
index 1246c73..e373859 100644
--- a/Android.mk
+++ b/Android.mk
@@ -292,12 +292,6 @@
framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:=$(call intermediates-dir-for,JAVA_LIBRARIES,framework)
-web_docs_sample_code_flags := \
- -hdf android.hasSamples 1 \
- -samplecode samples/ApiDemos guide/samples/ApiDemos "API Demos" \
- -samplecode samples/LunarLander guide/samples/LunarLander "Lunar Lander" \
- -samplecode samples/NotePad guide/samples/NotePad "Note Pad"
-
sample_dir := development/samples
web_docs_sample_code_flags := \
@@ -309,6 +303,19 @@
-samplecode $(sample_dir)/NotePad \
guide/samples/NotePad "Note Pad"
+# SDK version identifiers used in the published docs.
+
+# major[.minor] version for SDK. Typically identical to the
+# most current Android platform version included in the SDK package.
+framework_docs_SDK_VERSION := 1.5
+# release version for SDK (ie "Release x")
+framework_docs_SDK_REL_ID := 1
+framework_docs_SDK_CURRENT_DIR := $(framework_docs_SDK_VERSION)_r$(framework_docs_SDK_REL_ID)
+
+framework_docs_LOCAL_DROIDDOC_OPTIONS += \
+ -hdf sdk.version $(framework_docs_SDK_VERSION) \
+ -hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \
+ -hdf sdk.current $(framework_docs_SDK_CURRENT_DIR)
# ==== static html in the sdk ==================================
include $(CLEAR_VARS)
@@ -341,7 +348,7 @@
static_doc_index_redirect := $(out_dir)/index.html
$(static_doc_index_redirect): \
- $(LOCAL_PATH)/docs/docs-documentation-redirect.html | $(ACP)
+ $(LOCAL_PATH)/docs/docs-documentation-redirect.html | $(ACP)
$(hide) mkdir -p $(dir $@)
$(hide) $(ACP) $< $@
@@ -366,10 +373,10 @@
LOCAL_MODULE := online-sdk
LOCAL_DROIDDOC_OPTIONS:= \
- $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
- $(web_docs_sample_code_flags) \
- -toroot / \
- -hdf android.whichdoc online
+ $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
+ $(web_docs_sample_code_flags) \
+ -toroot / \
+ -hdf android.whichdoc online
LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=build/tools/droiddoc/templates-sdk
LOCAL_DROIDDOC_CUSTOM_ASSET_DIR:=assets-sdk