Skip to content

Commit

Permalink
pw_display: Create module directory
Browse files Browse the repository at this point in the history
- Create the empty pw_display module with docs.rst
- Update seed 104 to reflect the planned one module multiple library
  structure.

Change-Id: Ia8c81fc546bf03c54d9643d43a49a2db3e7a8e33
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/229712
Lint: Lint 🤖 <[email protected]>
Commit-Queue: Anthony DiGirolamo <[email protected]>
Reviewed-by: Kayce Basques <[email protected]>
  • Loading branch information
AnthonyDiGirolamo authored and CQ Bot Account committed Aug 14, 2024
1 parent 52eee72 commit c92db29
Show file tree
Hide file tree
Showing 11 changed files with 143 additions and 65 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ add_subdirectory(pw_containers EXCLUDE_FROM_ALL)
add_subdirectory(pw_cpu_exception EXCLUDE_FROM_ALL)
add_subdirectory(pw_cpu_exception_cortex_m EXCLUDE_FROM_ALL)
add_subdirectory(pw_digital_io EXCLUDE_FROM_ALL)
add_subdirectory(pw_display EXCLUDE_FROM_ALL)
add_subdirectory(pw_file EXCLUDE_FROM_ALL)
add_subdirectory(pw_function EXCLUDE_FROM_ALL)
add_subdirectory(pw_fuzzer EXCLUDE_FROM_ALL)
Expand Down
1 change: 1 addition & 0 deletions PIGWEED_MODULES
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ pw_digital_io
pw_digital_io_linux
pw_digital_io_mcuxpresso
pw_digital_io_rp2040
pw_display
pw_dma_mcuxpresso
pw_docgen
pw_doctor
Expand Down
5 changes: 5 additions & 0 deletions docs/module_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,11 @@
"C++17"
]
},
"pw_display": {
"tagline": "Graphic display support and framebuffer management",
"status": "experimental",
"languages": []
},
"pw_dma_mcuxpresso": {
"tagline": "DMA helpers for MCUXpresso SDK",
"status": "unstable",
Expand Down
1 change: 1 addition & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Libraries (modules)
pw_cpu_exception/docs
pw_crypto/docs
pw_digital_io/docs
pw_display/docs
pw_dma_mcuxpresso/docs
pw_docgen/docs
pw_doctor/docs
Expand Down
4 changes: 4 additions & 0 deletions pw_build/generated_pigweed_modules_lists.gni
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ declare_args() {
dir_pw_digital_io_mcuxpresso =
get_path_info("../pw_digital_io_mcuxpresso", "abspath")
dir_pw_digital_io_rp2040 = get_path_info("../pw_digital_io_rp2040", "abspath")
dir_pw_display = get_path_info("../pw_display", "abspath")
dir_pw_dma_mcuxpresso = get_path_info("../pw_dma_mcuxpresso", "abspath")
dir_pw_docgen = get_path_info("../pw_docgen", "abspath")
dir_pw_doctor = get_path_info("../pw_doctor", "abspath")
Expand Down Expand Up @@ -280,6 +281,7 @@ declare_args() {
dir_pw_digital_io_linux,
dir_pw_digital_io_mcuxpresso,
dir_pw_digital_io_rp2040,
dir_pw_display,
dir_pw_dma_mcuxpresso,
dir_pw_docgen,
dir_pw_doctor,
Expand Down Expand Up @@ -457,6 +459,7 @@ declare_args() {
"$dir_pw_digital_io_linux:tests",
"$dir_pw_digital_io_mcuxpresso:tests",
"$dir_pw_digital_io_rp2040:tests",
"$dir_pw_display:tests",
"$dir_pw_dma_mcuxpresso:tests",
"$dir_pw_docgen:tests",
"$dir_pw_doctor:tests",
Expand Down Expand Up @@ -634,6 +637,7 @@ declare_args() {
"$dir_pw_digital_io_linux:docs",
"$dir_pw_digital_io_mcuxpresso:docs",
"$dir_pw_digital_io_rp2040:docs",
"$dir_pw_display:docs",
"$dir_pw_dma_mcuxpresso:docs",
"$dir_pw_docgen:docs",
"$dir_pw_doctor:docs",
Expand Down
17 changes: 17 additions & 0 deletions pw_display/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2024 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, 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.

package(default_visibility = ["//visibility:public"])

licenses(["notice"])
28 changes: 28 additions & 0 deletions pw_display/BUILD.gn
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copyright 2024 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, 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.

import("//build_overrides/pigweed.gni")

import("$dir_pw_build/target_types.gni")
import("$dir_pw_docgen/docs.gni")
import("$dir_pw_sync/backend.gni")
import("$dir_pw_unit_test/test.gni")

pw_test_group("tests") {
tests = []
}

pw_doc_group("docs") {
sources = [ "docs.rst" ]
}
15 changes: 15 additions & 0 deletions pw_display/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2024 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, 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.

include($ENV{PW_ROOT}/pw_build/pigweed.cmake)
2 changes: 2 additions & 0 deletions pw_display/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[email protected]
[email protected]
10 changes: 10 additions & 0 deletions pw_display/docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _module-pw_display:

==========
pw_display
==========
.. pigweed-module::
:name: pw_display

.. attention::
This module is undergoing implementation as part of SEED :ref:`seed-0104`.
Loading

0 comments on commit c92db29

Please sign in to comment.