Skip to content

Commit 7a6e67f

Browse files
committed
Convert Docs to Consistent Naming Scheme
In #48 we discussed that the documentation files did not have a very consistent naming scheme. Some were using "_", "-", or " ". This commit converts them to one consistent style.
1 parent 75bbf72 commit 7a6e67f

34 files changed

+12
-12
lines changed

docs/Build & Debug/DebuggingWithXcode.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ You can use Xcode to build & debug WebKit. Open `WebKit.xcworkspace` at the top
55
In order to make Xcode use build files built by `make` command above,
66
go to File > Workspace Settings... > Advanced... > Custom > Relative to Workspace
77
and adjust the relative paths of Products and Intermediates to point to `WebKitBuild` directory.
8-
![Screenshot of Xcode Workspace Settings](../assets/xcode-workspace-settings.png)
9-
![Screenshot of Xcode Workspace Settings - Advanced Build Location](../assets/xcode-workspace-build-location.png)
8+
![Screenshot of Xcode Workspace Settings](/assets/XcodeWorkspaceSettings.png)
9+
![Screenshot of Xcode Workspace Settings - Advanced Build Location](/assets/XcodeWorkspaceBuildLocation.png)
1010
Note that debugging WebCore code typically requires attaching to the relevant WebContent process,
1111
not the application process, which is mostly running code in [Source/WebKit/UIProcess](https://github.com/WebKit/WebKit/tree/main/Source/WebKit/UIProcess).
1212
Depending on what you’re debugging, you’d have to attach & debug different processes in the coalition.
@@ -35,10 +35,10 @@ In Product > Scheme, select “All Source”.
3535
In Product > Scheme > Edit Scheme, open “Run” tab.
3636
Pick WebKitTestRunner or DumpRenderTree, whichever is desired in “Executable”.
3737

38-
![Screenshot of specifying DumpRenderTree as the target of "Run" scheme](../assets/xcode-scheme-dumprendertree.png)
38+
![Screenshot of specifying DumpRenderTree as the target of "Run" scheme](/assets/XcodeSchemeDumpRenderTree.png)
3939
Go to Arguments and specify the path to the layout tests being debugged relative to where the build directory is located.
4040
e.g. `../../LayoutTests/fast/dom/Element/element-traversal.html` if `WebKitBuild/Debug` is the build directory.
41-
![Screenshot of Xcode specifying a layout test in an argument to DumpRenderTree](../assets/xcode-scheme-layout-test.png)
41+
![Screenshot of Xcode specifying a layout test in an argument to DumpRenderTree](/assets/XcodeSchemeLayoutTest.png)
4242
You may want to specify OS_ACTIVITY_MODE environmental variable to “disable”
4343
in order to suppress all the system logging that happens during the debugging session.
4444

@@ -49,7 +49,7 @@ Once this is done, you can run WebKitTestRunner or DumpRenderTree by going to Pr
4949

5050
Clicking on “Run” button may be significantly slower due to Xcode re-building every project and framework each time.
5151
You can disable this behavior by going to “Build” tab and unchecking boxes for all the frameworks involved for “Run”:
52-
![Screenshot of Xcode unchecking build options for all but DumpRenderTree for "Run" scheme](../assets/xcode-build-settings-for-run.png)
52+
![Screenshot of Xcode unchecking build options for all but DumpRenderTree for "Run" scheme](/assets/XcodeBuildSettingsForRun.png)
5353

5454
### Attaching to WebContent Process
5555

docs/Deep Dive/Architecture/JSWrappers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Each `DOMWrapperWorld` has its own JS wrapper for each C++ object.
3232
As a result, a single C++ object may have multiple JS wrappers in distinct `DOMWrapperWorld`s.
3333
The most important `DOMWrapperWorld` is the main `DOMWrapperWorld` which runs the scripts of web pages WebKit loaded
3434
while other `DOMWrapperWorld`s are typically used to run code for browser extensions and other code injected by applications that embed WebKit.
35-
![Diagram of JS wrappers](../../assets/js-wrapper.png)
35+
![Diagram of JS wrappers](/assets/JSWrapper.png)
3636
JSX.h provides `toJS` functions which creates a JS wrapper for X
3737
in a given [global object](https://developer.mozilla.org/en-US/docs/Glossary/Global_object)’s `DOMWrapperWorld`,
3838
and toWrapped function which returns the underlying C++ object.

docs/Deep Dive/Architecture/Storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ StorageAreaBases)
1919
* MemoryStorageArea / SQLiteStorageArea (inherits StorageAreaBases; manage one local or session storage, like
2020
Webkit::StorageArea)
2121

22-
![Storage Manager](../../assets/Storage%20Manager.svg)
22+
![Storage Manager](/assets/StorageManager.svg)
2323

2424

2525
### Notes

docs/Deep Dive/Architecture/WebKit2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In addition to handling all network accesses,
1313
this process is also responsible for managing the disk cache and Web APIs that allow websites
1414
to store structured data such as [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)
1515
and [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API):
16-
![Diagram of WebKit2's multi-process architecture](../../assets/webkit2-process-architecture.png)
16+
![Diagram of WebKit2's multi-process architecture](/assets/Webkit2ProcessArchitecture.png)
1717
Because a WebContent process can Just-in-Time compile arbitrary JavaScript code loaded from the internet,
1818
meaning that it can write to memory that gets executed, this process is tightly sandboxed.
1919
It does not have access to any file system unless the user grants an access,

docs/Deep Dive/Build/AddingNewFile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Make sure to uncheck the target membership so that it’s not compiled as a part
1111
Instead, add the same file in Sources.txt file that exists in each subdirectory of Source.
1212
e.g. [Source/WebCore/Sources.txt](https://github.com/WebKit/WebKit/blob/main/Source/WebCore/Sources.txt) for WebCore.
1313
This will ensure the newly added file is compiled as a part of *unified sources*.
14-
![Screenshot of adding a file to Xcode](../../assets/xcode-add-file.png)
14+
![Screenshot of adding a file to Xcode](/assets/XcodeAddFile.png)
1515
When a header file in WTF is used in WebCore, or a header file in WebCore is used in WebKit or WebKitLegacy,
1616
we need to export the file to those projects.
1717
To do that, turn on the target membership in respective framework as set the membership to “Private” as seen below.
1818
This will ensure the relevant header file is exported from WTF / WebCore to other downstream projects like WebKitLegacy.
19-
![Screenshot of exporting a header file](../../assets/xcode-export-header.png)
19+
![Screenshot of exporting a header file](/assets/XcodeExportHeader.png)
2020

2121
Non-cocoa ports, like WPE and GTK, use CMake for building the project. If the header is not platform-specific, you might
2222
want to add an entry for it into the relevant Headers.cmake. For example, if a WebCore header is included by WebKit, you
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)