doc.go 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. // Copyright 2015 Google Inc. All rights reserved.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. // Soong is a builder for Android that uses Blueprint to parse Blueprints
  15. // files and Ninja to do the dependency tracking and subprocess management.
  16. // Soong itself is responsible for converting the modules read by Blueprint
  17. // into build rules, which will be written to a build.ninja file by Blueprint.
  18. //
  19. // Android build concepts:
  20. //
  21. // Device
  22. // A device is a piece of hardware that will be running Android. It may specify
  23. // global settings like architecture, filesystem configuration, initialization
  24. // scripts, and device drivers. A device may support all variants of a single
  25. // piece of hardware, or multiple devices may be used for different variants.
  26. // A build is never targeted directly at a device, it is always targeted at a
  27. // "product".
  28. //
  29. // Product
  30. // A product is a configuration of a device, often for a specific market or
  31. // use case. It is sometimes referred to as a "SKU". A product defines
  32. // global settings like supported languages, supported use cases, preinstalled
  33. // modules, and user-visible behavior choices. A product selects one and only
  34. // one device.
  35. //
  36. // Module
  37. // A module is a definition of something to be built. It may be a C library or
  38. // binary, a java library, an Android app, etc. A module may be built for multiple
  39. // targets, even in a single build, for example host and device, or 32-bit device
  40. // and 64-bit device.
  41. //
  42. // Installed module
  43. // An installed module is one that has been requested by the selected product,
  44. // or a dependency of an installed module.
  45. //
  46. // Target architecture
  47. // The target architecture is the preferred architecture supported by the selected
  48. // device. It is most commonly 32-bit arm, but may also be 64-bit arm, 32-bit
  49. // x86, or 64-bit x86.
  50. //
  51. // Secondary architecture
  52. // The secondary architecture specifies the architecture to compile a second copy
  53. // of some modules for devices that support multiple architectures, for example
  54. // 64-bit devices that also support 32-bit binaries.
  55. package soong