Google Git
Sign in
pigweed / pigweed / pigweed / 8e7ece1173d690eb19e54264af9a861eb04d1622
commit8e7ece1173d690eb19e54264af9a861eb04d1622[log] [tgz]
authorAlex Deymo <deymo@google.com>Thu Apr 21 19:25:48 2022 +0200
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Apr 22 15:33:31 2022 +0000
tree9e4d2c10ba891f50a66c1e8889d7493546f61619
parent6d46eaecc1f18ac8ede6778a8c65c5bbf72947f6 [diff]
third_party/boringssl: Document how to include this module

boringssl is a bit special since the BUILD.gn file includes a .gni from
the externally provided source directory. This means that if the path
to the source code (dir_third_party_boringssl) is defined in GN as a
default value the code must be present during bootstrap since GN needs
to parse the .gni file. In other third_party modules this is not a
problem since the source code is only used at compile time. In addition
to this, the .gni file is a generated one, not present in upstream
boringssl repository. "pw package" install process generates the file
but only after the initial system is installed.

This patch adds a docs.rst documentation explaining how to set up
boringssl with "pw package" avoiding these issues.

Change-Id: I94d2441400f05d9cc1ae1781e38af6ba0d8b3d74
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/92120
Reviewed-by: Rob Mohr <mohrr@google.com>
Reviewed-by: Yecheng Zhao <zyecheng@google.com>
Commit-Queue: Alex Deymo <deymo@google.com>
4 files changed
tree: 9e4d2c10ba891f50a66c1e8889d7493546f61619
  1. build_overrides/
  2. docker/
  3. docs/
  4. pw_allocator/
  5. pw_analog/
  6. pw_android_toolchain/
  7. pw_arduino_build/
  8. pw_assert/
  9. pw_assert_basic/
  10. pw_assert_log/
  11. pw_assert_tokenized/
  12. pw_assert_zephyr/
  13. pw_base64/
  14. pw_bloat/
  15. pw_blob_store/
  16. pw_bluetooth_hci/
  17. pw_boot/
  18. pw_boot_cortex_m/
  19. pw_build/
  20. pw_build_info/
  21. pw_build_mcuxpresso/
  22. pw_bytes/
  23. pw_checksum/
  24. pw_chrono/
  25. pw_chrono_embos/
  26. pw_chrono_freertos/
  27. pw_chrono_stl/
  28. pw_chrono_threadx/
  29. pw_chrono_zephyr/
  30. pw_cli/
  31. pw_console/
  32. pw_containers/
  33. pw_cpu_exception/
  34. pw_cpu_exception_cortex_m/
  35. pw_crypto/
  36. pw_docgen/
  37. pw_doctor/
  38. pw_env_setup/
  39. pw_file/
  40. pw_function/
  41. pw_fuzzer/
  42. pw_hdlc/
  43. pw_hex_dump/
  44. pw_i2c/
  45. pw_i2c_mcuxpresso/
  46. pw_interrupt/
  47. pw_interrupt_cortex_m/
  48. pw_interrupt_zephyr/
  49. pw_kvs/
  50. pw_libc/
  51. pw_log/
  52. pw_log_android/
  53. pw_log_basic/
  54. pw_log_null/
  55. pw_log_rpc/
  56. pw_log_string/
  57. pw_log_tokenized/
  58. pw_log_zephyr/
  59. pw_malloc/
  60. pw_malloc_freelist/
  61. pw_metric/
  62. pw_minimal_cpp_stdlib/
  63. pw_module/
  64. pw_multisink/
  65. pw_package/
  66. pw_persistent_ram/
  67. pw_polyfill/
  68. pw_preprocessor/
  69. pw_presubmit/
  70. pw_protobuf/
  71. pw_protobuf_compiler/
  72. pw_random/
  73. pw_result/
  74. pw_ring_buffer/
  75. pw_router/
  76. pw_rpc/
  77. pw_snapshot/
  78. pw_software_update/
  79. pw_span/
  80. pw_spi/
  81. pw_status/
  82. pw_stm32cube_build/
  83. pw_stream/
  84. pw_string/
  85. pw_symbolizer/
  86. pw_sync/
  87. pw_sync_baremetal/
  88. pw_sync_embos/
  89. pw_sync_freertos/
  90. pw_sync_stl/
  91. pw_sync_threadx/
  92. pw_sync_zephyr/
  93. pw_sys_io/
  94. pw_sys_io_arduino/
  95. pw_sys_io_baremetal_lm3s6965evb/
  96. pw_sys_io_baremetal_stm32f429/
  97. pw_sys_io_emcraft_sf2/
  98. pw_sys_io_mcuxpresso/
  99. pw_sys_io_stdio/
  100. pw_sys_io_stm32cube/
  101. pw_sys_io_zephyr/
  102. pw_system/
  103. pw_target_runner/
  104. pw_thread/
  105. pw_thread_embos/
  106. pw_thread_freertos/
  107. pw_thread_stl/
  108. pw_thread_threadx/
  109. pw_tls_client/
  110. pw_tls_client_boringssl/
  111. pw_tls_client_mbedtls/
  112. pw_tokenizer/
  113. pw_tool/
  114. pw_toolchain/
  115. pw_trace/
  116. pw_trace_tokenized/
  117. pw_transfer/
  118. pw_unit_test/
  119. pw_varint/
  120. pw_watch/
  121. pw_web_ui/
  122. pw_work_queue/
  123. targets/
  124. third_party/
  125. zephyr/
  126. .dockerignore ⇨ .gitignore
  127. activate.sh ⇨ bootstrap.sh
  128. .bazelignore
  129. .bazelrc
  130. .clang-format
  131. .clang-tidy
  132. .eslintrc.json
  133. .gitattributes
  134. .gitignore
  135. .gn
  136. .prettierrc.js
  137. .pylintrc
  138. activate.bat
  139. Android.bp
  140. AUTHORS
  141. bootstrap.bat
  142. bootstrap.sh
  143. BUILD.bazel
  144. BUILD.gn
  145. BUILDCONFIG.gn
  146. CMakeLists.txt
  147. Kconfig.zephyr
  148. LICENSE
  149. modules.gni
  150. OWNERS
  151. package.json
  152. PIGWEED_MODULES
  153. PW_PLUGINS
  154. README.md
  155. tsconfig.json
  156. WORKSPACE
  157. yarn.lock
README.md

Pigweed

Pigweed is an open source collection of embedded-targeted libraries–or as we like to call them, modules. These modules are building blocks and infrastructure that enable faster and more reliable development on small-footprint MMU-less 32-bit microcontrollers like the STMicroelectronics STM32L452 or the Nordic nRF52832.

For more information please see our website: https://pigweed.dev/

Links