diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c808cb800..706113b6b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -260,6 +260,14 @@ shellcheck: script: - shellcheck $(git grep -l "#\!/.*bin/.*sh") +spellcheck: + extends: + - .build_on_fedora + stage: analysis + script: + - git ls-files | grep -v .gitlab-ci.yml | xargs -d '\n' sed -i 's/Pipewire/PipeWire/g' + - git diff --exit-code || (echo "Please fix the above spelling mistakes" && exit 1) + pages: extends: - .not_coverity diff --git a/INSTALL.md b/INSTALL.md index c4de6abd3..23f3c881c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ ## Building -Pipewire uses a build tool called *Meson* as a basis for its build +PipeWire uses a build tool called *Meson* as a basis for its build process. It's a tool with some resemblance to Autotools and CMake. Meson again generates build files for a lower level build tool called *Ninja*, working in about the same level of abstraction as more familiar GNU Make @@ -33,7 +33,7 @@ Define the installation prefix: $ meson configure builddir -Dprefix=/usr # Default: /usr/local ``` -Pipewire specific build options are listed in the "Project options" +PipeWire specific build options are listed in the "Project options" section. They are defined in `meson_options.txt`. Finally, invoke the build: diff --git a/autogen.sh b/autogen.sh index 98cf4a8d9..5e0c381e7 100755 --- a/autogen.sh +++ b/autogen.sh @@ -7,7 +7,7 @@ if [ -z "$MESON" ]; then fi if [ -z "$MESON" ]; then echo "error: Meson not found." - echo "Install meson to configure and build Pipewire. If meson" \ + echo "Install meson to configure and build PipeWire. If meson" \ "is already installed, set the environment variable MESON" \ "to the binary's path." exit 1; diff --git a/spa/plugins/bluez5/bluez5-dbus.c b/spa/plugins/bluez5/bluez5-dbus.c index eb9f82f96..0c6da8a3e 100644 --- a/spa/plugins/bluez5/bluez5-dbus.c +++ b/spa/plugins/bluez5/bluez5-dbus.c @@ -3039,7 +3039,7 @@ static int adapter_register_endpoints(struct spa_bt_adapter *a) if (!a->endpoints_registered) { /* Should never happen as SBC support is always enabled */ - spa_log_error(monitor->log, "Broken Pipewire build - unable to locate SBC codec"); + spa_log_error(monitor->log, "Broken PipeWire build - unable to locate SBC codec"); err = -ENOSYS; } diff --git a/src/modules/module-protocol-pulse/pulse-server.c b/src/modules/module-protocol-pulse/pulse-server.c index c79e2fd54..45b4018f4 100644 --- a/src/modules/module-protocol-pulse/pulse-server.c +++ b/src/modules/module-protocol-pulse/pulse-server.c @@ -3220,7 +3220,7 @@ static int64_t get_port_latency_offset(struct client *client, struct pw_manager_ size_t j; /* - * The latency offset is a property of nodes in Pipewire, so we look it up on the + * The latency offset is a property of nodes in PipeWire, so we look it up on the * nodes. We'll return the latency offset of the first node in the port. * * This is also because we need to be consistent with diff --git a/src/pipewire/client.h b/src/pipewire/client.h index 89f3376e9..67725a9c4 100644 --- a/src/pipewire/client.h +++ b/src/pipewire/client.h @@ -35,7 +35,7 @@ extern "C" { #include #include -/** \defgroup pw_client Pipewire Client +/** \defgroup pw_client PipeWire Client * */ diff --git a/src/pipewire/context.h b/src/pipewire/context.h index f8d5fff6b..1f353423b 100644 --- a/src/pipewire/context.h +++ b/src/pipewire/context.h @@ -47,7 +47,7 @@ extern "C" { * */ -/** \defgroup pw_context Pipewire Context +/** \defgroup pw_context PipeWire Context * * \brief The PipeWire context object manages all locally available * resources. It is used by both clients and servers. diff --git a/src/pipewire/filter.h b/src/pipewire/filter.h index 59bbc79c7..5f8be0f47 100644 --- a/src/pipewire/filter.h +++ b/src/pipewire/filter.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_filter Pipewire Filter +/** \defgroup pw_filter PipeWire Filter * * \brief PipeWire filter object class * diff --git a/src/pipewire/impl-core.h b/src/pipewire/impl-core.h index 39353e490..61b26dfa7 100644 --- a/src/pipewire/impl-core.h +++ b/src/pipewire/impl-core.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_impl_core Pipewire Core Interface +/** \defgroup pw_impl_core PipeWire Core Interface * * \brief PipeWire core interface. * diff --git a/src/pipewire/impl-device.h b/src/pipewire/impl-device.h index 5bb0410b0..a6ab70d7c 100644 --- a/src/pipewire/impl-device.h +++ b/src/pipewire/impl-device.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_impl_device Pipewire Device Interface +/** \defgroup pw_impl_device PipeWire Device Interface * * The device is an object that manages nodes. It typically * corresponds to a physical hardware device but it does not diff --git a/src/pipewire/impl-factory.h b/src/pipewire/impl-factory.h index 9bba86f83..f0333d919 100644 --- a/src/pipewire/impl-factory.h +++ b/src/pipewire/impl-factory.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_impl_factory Pipewire Factory Interface +/** \defgroup pw_impl_factory PipeWire Factory Interface * * The factory is used to make objects on demand. */ diff --git a/src/pipewire/impl-metadata.h b/src/pipewire/impl-metadata.h index 492cc6981..8fddc2653 100644 --- a/src/pipewire/impl-metadata.h +++ b/src/pipewire/impl-metadata.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_impl_metadata Pipewire Metadata Interface +/** \defgroup pw_impl_metadata PipeWire Metadata Interface * * The metadata is used to store key/type/value pairs per object id. */ diff --git a/src/pipewire/link.h b/src/pipewire/link.h index caa40e293..4493dcf74 100644 --- a/src/pipewire/link.h +++ b/src/pipewire/link.h @@ -34,7 +34,7 @@ extern "C" { #include -/** \defgroup pw_link Pipewire Link +/** \defgroup pw_link PipeWire Link * * A link is the connection between 2 nodes (\ref pw_node). Nodes are * linked together on ports. diff --git a/src/pipewire/loop.h b/src/pipewire/loop.h index b7c439a16..896c96fe8 100644 --- a/src/pipewire/loop.h +++ b/src/pipewire/loop.h @@ -32,7 +32,7 @@ extern "C" { #include #include -/** \defgroup pw_loop Pipewire Loop +/** \defgroup pw_loop PipeWire Loop * * PipeWire loop object provides an implementation of * the spa loop interfaces. It can be used to implement various diff --git a/src/pipewire/main-loop.h b/src/pipewire/main-loop.h index 29230608f..3b80a43cc 100644 --- a/src/pipewire/main-loop.h +++ b/src/pipewire/main-loop.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_main_loop Pipewire Main-Loop Interface +/** \defgroup pw_main_loop PipeWire Main-Loop Interface * * A main loop object */ diff --git a/src/pipewire/node.h b/src/pipewire/node.h index 91cf45837..98b7a2eb4 100644 --- a/src/pipewire/node.h +++ b/src/pipewire/node.h @@ -39,7 +39,7 @@ extern "C" { #include -/** \defgroup pw_node Pipewire Node +/** \defgroup pw_node PipeWire Node * */ diff --git a/src/pipewire/permission.h b/src/pipewire/permission.h index 6b914bf28..3eb2c7cae 100644 --- a/src/pipewire/permission.h +++ b/src/pipewire/permission.h @@ -31,7 +31,7 @@ extern "C" { #include -/** \defgroup pw_permission Pipewire Permission +/** \defgroup pw_permission PipeWire Permission * * Permissions are kept for a client and describe what the client is * allowed to do with an object. diff --git a/src/pipewire/port.h b/src/pipewire/port.h index 235b7dc3d..cb277b9b3 100644 --- a/src/pipewire/port.h +++ b/src/pipewire/port.h @@ -38,7 +38,7 @@ extern "C" { #include -/** \defgroup pw_port Pipewire Port +/** \defgroup pw_port PipeWire Port * */ diff --git a/src/pipewire/type.h b/src/pipewire/type.h index e026e839e..5fd9511ee 100644 --- a/src/pipewire/type.h +++ b/src/pipewire/type.h @@ -31,7 +31,7 @@ extern "C" { #include -/** \defgroup pw_type Pipewire Types +/** \defgroup pw_type PipeWire Types */ /** diff --git a/src/pipewire/utils.h b/src/pipewire/utils.h index ff9317cb2..8e180f50d 100644 --- a/src/pipewire/utils.h +++ b/src/pipewire/utils.h @@ -38,7 +38,7 @@ extern "C" { #include #include -/** \defgroup pw_utils Pipewire Utility Functions +/** \defgroup pw_utils PipeWire Utility Functions * * Various utility functions */