Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-05 13:40:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

Adjust the language used in some of the documentation (#31583)

Browse source 
* fixed a typo in the Android setup command

* Fix typo in documentation for command-line arguments

* Fix style and formatting issues in the Shell Scripts section of the documentation

* Update style.md

* Fixed various  inconsistencies

* Fixed various inconsistencies

* Update webxr.md

* Update style.md

* Update COMMAND_LINE_ARGS.md

* Update README.md

Co-authored-by: Martin Robinson <mrobinson@igalia.com>

* Update docs/COMMAND_LINE_ARGS.md

---------

Co-authored-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
Okhuomon Ajayi 2024-03-08 15:11:28 +01:00 • committed by GitHub
parent 7e8a1503ba
commit 0327d4638b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -76,7 +76,7 @@ See also [Windows Troubleshooting Tips][windows-tips].
- Install the latest version of the [Android command-line - Install the latest version of the [Android command-line
tools](https://developer.android.com/studio#command-tools) to tools](https://developer.android.com/studio#command-tools) to
`$ANDROID_SDK_ROOT/cmdline-tools/latest`. `$ANDROID_SDK_ROOT/cmdline-tools/latest`.
- Run the following command to install the necessary components and the path t - Run the following command to install the necessary components:
```shell ```shell
sudo $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --install sudo $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --install
"build-tools;33.0.2" \ "build-tools;33.0.2" \

2
docs/COMMAND_LINE_ARGS.md
View file

@ -11,7 +11,7 @@ Only arguments that need more explanation will be documented here.
# Run # Run
## Enable Experimental Features ## Enable Experimental Features
Use `--pref` to enable experimental features like experimental DOM API, JavaScript API and CSS properties. Use `--pref` to enable experimental features like experimental DOM APIs, JavaScript APIs and CSS properties.
e.g. To enable Web VR and Bluetooth features: e.g. To enable Web VR and Bluetooth features:
``` ```

6
docs/STYLE_GUIDE.md
View file

@ -5,10 +5,10 @@ automated linters. This document has guidelines that are less easy to lint for.
## Shell scripts ## Shell scripts
Shell scripts are OK for small tasks or wrappers, but prefer to use Python for Shell scripts are suitable for small tasks or wrappers, but it's preferable to use Python for
anything with a hint of complexity or in general. anything with a hint of complexity or in general.
Shell scripts should be written against bash, starting with this shebang: Shell scripts should be written using bash, starting with this shebang:
``` ```
#!/usr/bin/env bash #!/usr/bin/env bash
``` ```
@ -23,7 +23,7 @@ set -o nounset
set -o pipefail set -o pipefail
``` ```
Quote all variables, using the full form: `"${SOME_VARIABLE}"`. Rememeber to quote all variables, using the full form: `"${SOME_VARIABLE}"`.
Use `"$(some-command)"` instead of backticks for command substitution. Note Use `"$(some-command)"` instead of backticks for command substitution. Note
that these should be quoted as well. that these should be quoted as well.

10
docs/components/style.md
View file

@ -1,15 +1,15 @@
# Servo's style system overview # Servo's style system overview
This needs to be filled more extensively. Meanwhile, you can also take a look at This document provides an overview of Servo's style system. For more extensive details,
the [style doc comments][style-doc], or the [Styling refer to the [style doc comments][style-doc], or the [Styling
Overview][wiki-styling-overview] in the wiki, a conversation between Overview][wiki-styling-overview] in the wiki, which includes a conversation between
Boris Zbarsky and Patrick Walton about how style sharing works. Boris Zbarsky and Patrick Walton about how style sharing works.
<a name="selector-impl"></a> <a name="selector-impl"></a>
## Selector Implementation ## Selector Implementation
In order to be sharable and compatible with Stylo (a project that aims To ensure compatibility with Stylo (a project integrating Servo's style system into Gecko),
to integrate Servo's style system into Gecko), the style must be consistent. selectors must be consistent.
The consistency is implemented in [selectors' SelectorImpl][selector-impl], The consistency is implemented in [selectors' SelectorImpl][selector-impl],
containing the logic related to parsing pseudo-elements and other pseudo-classes containing the logic related to parsing pseudo-elements and other pseudo-classes

22
docs/components/webxr.md
View file

@ -2,22 +2,22 @@
## Terminology ## Terminology
There are three main components involved in Servo's WebXR implementation: Servo's WebXR implementation involves three main components:
1. the script thread (runs all JS for a page) 1. The script thread (runs all JS for a page)
2. the WebGL thread (maintains WebGL canvas data and invokes GL operations corresponding to [WebGL APIs](https://registry.khronos.org/webgl/specs/latest/1.0/)) 2. The WebGL thread (maintains WebGL canvas data and invokes GL operations corresponding to [WebGL APIs](https://registry.khronos.org/webgl/specs/latest/1.0/))
3. the compositor (AKA the main thread) 3. The compositor (AKA the main thread)
Additionally, there are a number of WebXR-specific concepts: Additionally, there are a number of WebXR-specific concepts:
* the [discovery object](https://doc.servo.org/webxr_api/trait.DiscoveryAPI.html) (ie. how Servo discovers if a device can provide a WebXR session) * The [discovery object](https://doc.servo.org/webxr_api/trait.DiscoveryAPI.html) (ie. how Servo discovers if a device can provide a WebXR session)
* the [WebXR registry](https://doc.servo.org/webxr_api/struct.MainThreadRegistry.html) (the compositor's interface to WebXR) * The [WebXR registry](https://doc.servo.org/webxr_api/struct.MainThreadRegistry.html) (the compositor's interface to WebXR)
* the [layer manager](https://doc.servo.org/webxr_api/layer/trait.LayerManagerAPI.html) (manages WebXR layers for a given session and frame operations on those layers) * The [layer manager](https://doc.servo.org/webxr_api/layer/trait.LayerManagerAPI.html) (manages WebXR layers for a given session and frame operations on those layers)
* ths [layer grand manager](https://doc.servo.org/webxr_api/layer/trait.LayerGrandManagerAPI.html) (manages all layer managers for WebXR sessions) * The [layer grand manager](https://doc.servo.org/webxr_api/layer/trait.LayerGrandManagerAPI.html) (manages all layer managers for WebXR sessions)
Finally, there are graphics-specific concepts that are important for the low-level details of rendering with WebXR: Finally, there are graphics-specific concepts that are important for the low-level details of rendering with WebXR:
* [surfman](https://github.com/servo/webxr/blob/main/webxr/glwindow/mod.rs#L448-L452) is a crate that abstracts away platform-specific details of OpenGL hardware-accelerated rendering * [surfman](https://github.com/servo/webxr/blob/main/webxr/glwindow/mod.rs#L448-L452) is a crate that abstracts away platform-specific details of OpenGL hardware-accelerated rendering
* a [surface](https://doc.servo.org/surfman/platform/unix/default/surface/type.Surface.html) is a hardware buffer that are tied to a specific OpenGL context * [surface](https://doc.servo.org/surfman/platform/unix/default/surface/type.Surface.html) is a hardware buffer that are tied to a specific OpenGL context
* a [surface texture](https://doc.servo.org/surfman/platform/unix/default/surface/type.SurfaceTexture.html) is an OpenGL texture that wraps a surface. Surface textures can be shared between OpenGL contexts. * [surface texture](https://doc.servo.org/surfman/platform/unix/default/surface/type.SurfaceTexture.html) is an OpenGL texture that wraps a surface. Surface textures can be shared between OpenGL contexts.
* a [surfman context](https://doc.servo.org/surfman/platform/unix/default/context/type.Context.html) represents a particular OpenGL context, and is backed by platform-specific implementations (such as EGL on Unix-based platforms) * [surfman context](https://doc.servo.org/surfman/platform/unix/default/context/type.Context.html) represents a particular OpenGL context, and is backed by platform-specific implementations (such as EGL on Unix-based platforms)
* [ANGLE](https://github.com/servo/mozangle/) is an OpenGL implementation on top of Direct3D which is used in Servo to provide a consistent OpenGL backend on Windows-based platforms * [ANGLE](https://github.com/servo/mozangle/) is an OpenGL implementation on top of Direct3D which is used in Servo to provide a consistent OpenGL backend on Windows-based platforms
## How Servo's compositor starts ## How Servo's compositor starts