Cleanup, comments about the structure of device.mk

The only functional change is that this adds hdpi
for all builds on crespo hardware.

Change-Id: Ie48e3dfdcaeba23db85a0f067a23edb075c8f958

3 files changed, 48 insertions, 11 deletions

diff --git a/crespo.mk b/crespo.mk
index 1ac2ff0..c40cc57 100644
--- a/crespo.mk
+++ b/crespo.mk
@@ -14,7 +14,7 @@
 
 #
 # This file is the build configuration for a full Android
-# build for dream hardware. This cleanly combines a set of
+# build for crespo hardware. This cleanly combines a set of
 # device-specific aspects (drivers) with a device-agnostic
 # product configuration (apps).
 #
diff --git a/device.mk b/device.mk
index 6e31d21..93366d5 100644
--- a/device.mk
+++ b/device.mk
@@ -11,15 +11,44 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#
 
+
+# This file is the device-specific product definition file for
+# crespo. It lists all the overlays, files, modules and properties
+# that are specific to this hardware: i.e. those are device-specific
+# drivers, configuration files, settings, etc...
+
+# Note that crespo is not a fully open device. Some of the drivers
+# aren't publicly available in all circumstances, which means that some
+# of the hardware capabilities aren't present in builds where those
+# drivers aren't available. Such cases are handled by having this file
+# separated into two halves: this half here contains the parts that
+# are available to everyone, while another half in the vendor/ hierarchy
+# augments that set with the parts that are only relevant when all the
+# associated drivers are available. Aspects that are irrelevant but
+# harmless in no-driver builds should be kept here for simplicity and
+# transparency. There are two variants of the half that deals with
+# the unavailable drivers: one is directly checked into the unreleased
+# vendor tree and is used by engineers who have access to it. The other
+# is generated by setup-makefile.sh in the same directory as this files,
+# and is used by people who have access to binary versions of the drivers
+# but not to the original vendor tree. Be sure to update both.
+
+
+
+# These is the hardware-specific overlay, which points to the location
+# of hardware-specific resource overrides, typically the frameworks and
+# application settings that are stored in resourced.
 DEVICE_PACKAGE_OVERLAYS := device/samsung/crespo/overlay
 
-PRODUCT_COPY_FILES += \
+# These are the hardware-specific configuration files
+PRODUCT_COPY_FILES := \
 	device/samsung/crespo/asound.conf:system/etc/asound.conf \
 	device/samsung/crespo/vold.conf:system/etc/vold.conf \
-	device/samsung/crespo/vold.fstab:system/etc/vold.fstab
+	device/samsung/crespo/vold.fstab:system/etc/vold.fstab \
+	device/samsung/crespo/egl.cfg:system/lib/egl/egl.cfg
 
+# These are the hardware-specific features
 PRODUCT_COPY_FILES += \
 	frameworks/base/data/etc/handheld_core_hardware.xml:system/etc/permissions/handheld_core_hardware.xml \
 	frameworks/base/data/etc/android.hardware.camera.flash-autofocus.xml:system/etc/permissions/android.hardware.camera.flash-autofocus.xml \
@@ -33,15 +62,23 @@ PRODUCT_COPY_FILES += \
 	frameworks/base/data/etc/android.software.sip.xml:system/etc/permissions/android.software.sip.xml \
 	frameworks/base/data/etc/android.software.sip.voip.xml:system/etc/permissions/android.software.sip.voip.xml \
 	frameworks/base/data/etc/android.hardware.touchscreen.multitouch.distinct.xml:system/etc/permissions/android.hardware.touchscreen.multitouch.distinct.xml \
-	packages/wallpapers/LivePicker/android.software.live_wallpaper.xml:/system/etc/permissions/android.software.live_wallpaper.xml
-
+	packages/wallpapers/LivePicker/android.software.live_wallpaper.xml:system/etc/permissions/android.software.live_wallpaper.xml
 
-PRODUCT_COPY_FILES += \
-       device/samsung/crespo/egl.cfg:system/lib/egl/egl.cfg
-	
+# These are the hardware-specific settings that are stored in system properties.
+# Note that the only such settings should be the ones that are too low-level to
+# be reachable from resources or other mechanisms.
 PRODUCT_PROPERTY_OVERRIDES := \
        wifi.interface=eth0 \
        dalvik.vm.heapsize=24m
 
-# Get non-open-source aspects if available
+# Screen density is actually considered a locale (since it is taken into account
+# the the build-time selection of resources). The product definitions including
+# this file must pay attention to the fact that the first entry in the final
+# PRODUCT_LOCALES expansion must not be a density.
+PRODUCT_LOCALES := hdpi
+
+# See comment at the top of this file. This is where the other
+# half of the device-specific product definition file takes care
+# of the aspects that require proprietary drivers that aren't
+# commonly available
 $(call inherit-product-if-exists, vendor/samsung/crespo/device-vendor.mk)
diff --git a/full_crespo.mk b/full_crespo.mk
index 67c025a..c6957e0 100644
--- a/full_crespo.mk
+++ b/full_crespo.mk
@@ -14,7 +14,7 @@
 
 #
 # This file is the build configuration for a full Android
-# build for passion hardware. This cleanly combines a set of
+# build for crespo hardware. This cleanly combines a set of
 # device-specific aspects (drivers) with a device-agnostic
 # product configuration (apps).
 #