Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust the language used in some of the documentation #31583

Merged
merged 11 commits into from Mar 8, 2024
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -76,7 +76,7 @@ See also [Windows Troubleshooting Tips][windows-tips].
- Install the latest version of the [Android command-line
tools](https://developer.android.com/studio#command-tools) to
`$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 and the path :
six-shot marked this conversation as resolved.
Show resolved Hide resolved
```shell
sudo $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --install
"build-tools;33.0.2" \
Expand Down
2 changes: 1 addition & 1 deletion docs/COMMAND_LINE_ARGS.md
Expand Up @@ -11,7 +11,7 @@ Only arguments that need more explanation will be documented here.

# Run
## 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 the experimental DOM API, JavaScript API and CSS properties.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use `--pref` to enable experimental features like the 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:
```
Expand Down
6 changes: 3 additions & 3 deletions docs/STYLE_GUIDE.md
Expand Up @@ -5,10 +5,10 @@ automated linters. This document has guidelines that are less easy to lint for.

## 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.

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
```
Expand All @@ -23,7 +23,7 @@ set -o nounset
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
that these should be quoted as well.
8 changes: 3 additions & 5 deletions docs/components/style.md
@@ -1,15 +1,13 @@
# Servo's style system overview

This needs to be filled more extensively. Meanwhile, you can also take a look at
the [style doc comments][style-doc], or the [Styling
Overview][wiki-styling-overview] in the wiki, a conversation between
This document provides an overview of Servo's style system. For more extensive details, refer to the [style doc comments][style-doc], or the [Styling
Overview][wiki-styling-overview] in the wiki, which includes a conversation between
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please try to preserve the line length here.

Boris Zbarsky and Patrick Walton about how style sharing works.

<a name="selector-impl"></a>
## Selector Implementation

In order to be sharable and compatible with Stylo (a project that aims
to integrate Servo's style system into Gecko), the style must be consistent.
To ensure compatibility with Stylo (a project integrating Servo's style system into Gecko), selectors must be consistent.

The consistency is implemented in [selectors' SelectorImpl][selector-impl],
containing the logic related to parsing pseudo-elements and other pseudo-classes
Expand Down
28 changes: 14 additions & 14 deletions docs/components/webxr.md
Expand Up @@ -2,22 +2,22 @@

## Terminology

There are three main components involved in Servo's WebXR implementation:
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/))
3. the compositor (AKA the main thread)
Servo's WebXR implementation involves three main components:
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/))
3. The compositor (AKA the main thread)

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 [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)
* ths [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:
* [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
* 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.
* 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it makes sense to capitalize surfman here since the name of the project starts with lower-case letter.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i Would fix it now sir

* 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 [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 grand manager](https://doc.servo.org/webxr_api/layer/trait.LayerGrandManagerAPI.html) (manages all layer managers for WebXR sessions)

Furthermore, there are graphics-specific concepts that are important for the low-level details of rendering with WebXR:
six-shot marked this conversation as resolved.
Show resolved Hide resolved
* [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
* [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 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)
* [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
Expand Down