Skip to content

Commit f4dcfb6

Browse files
authoredMar 8, 2021
Switch primary git branch from master to main (emscripten-core#13624)
1 parent aa66f92 commit f4dcfb6

39 files changed

+82
-80
lines changed
 

‎.github/workflows/archive.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
tags:
66
push:
77
branches:
8-
- master
8+
- main
99
pull_request:
1010

1111
jobs:

‎ChangeLog.md

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ See docs/process.md for more on how version tagging works.
2121
Current Trunk
2222
-------------
2323

24+
- Primary development branch switched from `master` to `main`.
25+
2426
2.0.15: 03/05/2021
2527
------------------
2628
- Calls to `newlocale` (and `new std::locale` in C++) with arbirary names will

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Main project page: <https://emscripten.org>
44

5-
GitHub CI status: [![CircleCI](https://circleci.com/gh/emscripten-core/emscripten.svg?style=svg)](https://circleci.com/gh/emscripten-core/emscripten/tree/master)
5+
GitHub CI status: [![CircleCI](https://circleci.com/gh/emscripten-core/emscripten.svg?style=svg)](https://circleci.com/gh/emscripten-core/emscripten/tree/main)
66

77
Chromium builder status: [emscripten-releases](https://ci.chromium.org/p/emscripten-releases)
88

‎docs/paper.tex

+1-1
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ \subsection{Benchmarks}
655655

656656
The first column is the name of the benchmark, and in parentheses any
657657
parameters used in running it. The source code to all the benchmarks
658-
can be found at \url{https://github.com/kripken/emscripten/tree/master/tests}
658+
can be found at \url{https://github.com/kripken/emscripten/tree/main/tests}
659659
(each in a separate file with its name, except for `primes', which is
660660
embedded inside runner.py in the function test\_primes). A brief summary of
661661
the benchmarks is as follows:

‎docs/process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ How:
6666
3. Tag the emsdk repo as well, on the commit that does the update, after it
6767
lands on master.
6868
4. Update
69-
[emscripten-version.txt](https://github.com/emscripten-core/emscripten/blob/master/emscripten-version.txt)
69+
[emscripten-version.txt](https://github.com/emscripten-core/emscripten/blob/main/emscripten-version.txt)
7070
in the emscripten repo. This is a delayed update, in that the tag will refer
7171
to the actual release, but the update to emscripten-version.txt is a new
7272
commit to emscripten that happens later.

‎site/source/docs/api_reference/Filesystem-API.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
File System API
55
===============
66

7-
File operations in Emscripten are provided by the `FS <https://github.com/emscripten-core/emscripten/blob/master/src/library_fs.js>`_ library. It is used internally for all of Emscripten's **libc** and **libcxx** file I/O.
7+
File operations in Emscripten are provided by the `FS <https://github.com/emscripten-core/emscripten/blob/main/src/library_fs.js>`_ library. It is used internally for all of Emscripten's **libc** and **libcxx** file I/O.
88

99
.. note:: The API is *inspired* by the Linux/POSIX `File System API <http://linux.die.net/man/2/>`_, with each presenting a very similar interface.
1010

1111
The underlying behaviour is also similar, except where differences between the
1212
native and browser environments make this unreasonable. For example, user and
1313
group permissions are defined but ignored in :js:func:`FS.open`.
1414

15-
Emscripten predominantly compiles code that uses synchronous file I/O, so the majority of the ``FS`` member functions offer a synchronous interface (with errors being reported by raising exceptions of type `FS.ErrnoError <https://github.com/emscripten-core/emscripten/blob/master/system/lib/libc/musl/arch/emscripten/bits/errno.h>`_).
15+
Emscripten predominantly compiles code that uses synchronous file I/O, so the majority of the ``FS`` member functions offer a synchronous interface (with errors being reported by raising exceptions of type `FS.ErrnoError <https://github.com/emscripten-core/emscripten/blob/main/system/lib/libc/musl/arch/emscripten/bits/errno.h>`_).
1616

1717
File data in Emscripten is partitioned by mounted file systems. Several file systems are provided. An instance of :ref:`MEMFS <filesystem-api-memfs>` is mounted to ``/`` by default. The subdirectories `/home/web_user` and `/tmp` are also created automatically, in addition to several other special devices and streams (e.g. `/dev/null`, `/dev/random`, `/dev/stdin`, `/proc/self/fd`); see `FS.staticInit()` in the FS library for full details. Instances of :ref:`NODEFS <filesystem-api-nodefs>` and :ref:`IDBFS <filesystem-api-idbfs>` can be mounted to other directories if your application needs to :ref:`persist data <filesystem-api-persist-data>`.
1818

@@ -62,7 +62,7 @@ NODEFS
6262

6363
This file system lets a program in *node* map directories (via a mount operation) on the host filesystem to directories in Emscripten's virtual filesystem. It uses node's synchronous `FS API <http://nodejs.org/api/fs.html>`_ to immediately persist any data written to the Emscripten file system to your local disk.
6464

65-
See `this test <https://github.com/emscripten-core/emscripten/blob/master/tests/fs/test_nodefs_rw.c>`_ for an example.
65+
See `this test <https://github.com/emscripten-core/emscripten/blob/main/tests/fs/test_nodefs_rw.c>`_ for an example.
6666

6767
.. _filesystem-api-idbfs:
6868

@@ -219,7 +219,7 @@ File system API
219219
});
220220
}
221221
222-
A real example of this functionality can be seen in `test_idbfs_sync.c <https://github.com/emscripten-core/emscripten/blob/master/tests/fs/test_idbfs_sync.c>`_.
222+
A real example of this functionality can be seen in `test_idbfs_sync.c <https://github.com/emscripten-core/emscripten/blob/main/tests/fs/test_idbfs_sync.c>`_.
223223

224224
:param bool populate: ``true`` to initialize Emscripten's file system data with the data from the file system's persistent source, and ``false`` to save Emscripten`s file system data to the file system's persistent source.
225225
:param callback: A notification callback function that is invoked on completion of the synchronization. If an error occurred, it will be provided as a parameter to this function.

‎site/source/docs/api_reference/advanced-apis.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This section lists APIs that are not suitable for general use, but which may be
1616
settings.js
1717
============
1818

19-
`settings.js <https://github.com/emscripten-core/emscripten/blob/master/src/settings.js>`_ contains default values and options used in various places by the compiler.
19+
`settings.js <https://github.com/emscripten-core/emscripten/blob/main/src/settings.js>`_ contains default values and options used in various places by the compiler.
2020

2121
.. Warning :: Many **settings.js** options are highly brittle - certain combinations of options, and combinations of certain options used with some source code, can cause Emscripten to fail badly. This is intended for use by "advanced users", and possibly even only people developing Emscripten itself.
2222
@@ -36,7 +36,7 @@ The small number of options that developers may have cause to change should be m
3636
preamble.js
3737
===========
3838

39-
The following advanced APIs are documented in `preamble.js <https://github.com/emscripten-core/emscripten/blob/master/src/preamble.js>`_.
39+
The following advanced APIs are documented in `preamble.js <https://github.com/emscripten-core/emscripten/blob/main/src/preamble.js>`_.
4040

4141
.. js:function:: allocate(slab, allocator)
4242

‎site/source/docs/api_reference/bind.h.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
bind.h (under-construction)
55
===========================
66

7-
The C++ APIs in `bind.h <https://github.com/emscripten-core/emscripten/blob/master/system/include/emscripten/bind.h>`_ define
7+
The C++ APIs in `bind.h <https://github.com/emscripten-core/emscripten/blob/main/system/include/emscripten/bind.h>`_ define
88

99
Guide documentation for this API can be found in :ref:`Embind`.
1010

‎site/source/docs/api_reference/emscripten.h.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
emscripten.h
55
============
66

7-
This page documents the public C++ APIs provided by `emscripten.h <https://github.com/emscripten-core/emscripten/blob/master/system/include/emscripten/emscripten.h>`_.
7+
This page documents the public C++ APIs provided by `emscripten.h <https://github.com/emscripten-core/emscripten/blob/main/system/include/emscripten/emscripten.h>`_.
88

99
Emscripten uses existing/familiar APIs where possible (for example: :term:`SDL`). This API provides C++ support for capabilities that are specific to JavaScript or the browser environment, or for which there is no existing API.
1010

@@ -1254,7 +1254,7 @@ Typedefs
12541254
12551255
Unaligned types. These may be used to force LLVM to emit unaligned loads/stores in places in your code where :ref:`SAFE_HEAP <debugging-SAFE-HEAP>` found an unaligned operation.
12561256
1257-
For usage examples see `tests/core/test_set_align.c <https://github.com/emscripten-core/emscripten/blob/master/tests/core/test_set_align.c>`_.
1257+
For usage examples see `tests/core/test_set_align.c <https://github.com/emscripten-core/emscripten/blob/main/tests/core/test_set_align.c>`_.
12581258
12591259
.. note:: It is better to avoid unaligned operations, but if you are reading from a packed stream of bytes or such, these types may be useful!
12601260

‎site/source/docs/api_reference/fiber.h.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
fiber.h
55
=======
66

7-
`Fibers <https://en.wikipedia.org/wiki/Fiber_(computer_science)>`_ are light, co-operative threads of execution. The `fiber.h <https://github.com/emscripten-core/emscripten/blob/master/system/include/emscripten/fiber.h>`_ header defines a low-level API for manipulating Fibers in Emscripten. Fibers are implemented with :ref:`Asyncify`, so you must link your program with ``-s ASYNCIFY`` if you intend to use them.
7+
`Fibers <https://en.wikipedia.org/wiki/Fiber_(computer_science)>`_ are light, co-operative threads of execution. The `fiber.h <https://github.com/emscripten-core/emscripten/blob/main/system/include/emscripten/fiber.h>`_ header defines a low-level API for manipulating Fibers in Emscripten. Fibers are implemented with :ref:`Asyncify`, so you must link your program with ``-s ASYNCIFY`` if you intend to use them.
88

99
Fibers are intended as a building block for asynchronous control flow constructs,
1010
such as coroutines. They supersede the legacy coroutine API that was available

‎site/source/docs/api_reference/html5.h.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
html5.h
55
=======
66

7-
The C++ APIs in `html5.h <https://github.com/emscripten-core/emscripten/blob/master/system/include/emscripten/html5.h>`_ define the Emscripten low-level glue bindings to interact with HTML5 events from native code.
7+
The C++ APIs in `html5.h <https://github.com/emscripten-core/emscripten/blob/main/system/include/emscripten/html5.h>`_ define the Emscripten low-level glue bindings to interact with HTML5 events from native code.
88

99
.. tip:: The C++ APIs map closely to their :ref:`equivalent HTML5 JavaScript APIs <specifications-html5-api>`. The HTML5 specifications listed below provide additional detailed reference "over and above" the information provided in this document.
1010

@@ -131,9 +131,9 @@ Test/Example code
131131

132132
The HTML5 test code demonstrates how to use this API:
133133

134-
- `test_html5_core.c <https://github.com/emscripten-core/emscripten/blob/master/tests/test_html5_core.c>`_
135-
- `test_html5_fullscreen.c <https://github.com/emscripten-core/emscripten/blob/master/tests/test_html5_fullscreen.c>`_
136-
- `test_html5_mouse.c <https://github.com/emscripten-core/emscripten/blob/master/tests/test_html5_mouse.c>`_
134+
- `test_html5_core.c <https://github.com/emscripten-core/emscripten/blob/main/tests/test_html5_core.c>`_
135+
- `test_html5_fullscreen.c <https://github.com/emscripten-core/emscripten/blob/main/tests/test_html5_fullscreen.c>`_
136+
- `test_html5_mouse.c <https://github.com/emscripten-core/emscripten/blob/main/tests/test_html5_mouse.c>`_
137137

138138

139139
General types

‎site/source/docs/api_reference/module.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,5 +161,5 @@ Other methods
161161

162162
.. js:function:: Module.onCustomMessage
163163

164-
When compiled with ``PROXY_TO_WORKER = 1`` (see `settings.js <https://github.com/emscripten-core/emscripten/blob/master/src/settings.js>`_), this callback (which should be implemented on both the client and worker's ``Module`` object) allows sending custom messages and data between the web worker and the main thread (using the ``postCustomMessage`` function defined in `proxyClient.js <https://github.com/emscripten-core/emscripten/blob/master/src/proxyClient.js>`_ and `proxyWorker.js <https://github.com/emscripten-core/emscripten/blob/master/src/proxyWorker.js>`_).
164+
When compiled with ``PROXY_TO_WORKER = 1`` (see `settings.js <https://github.com/emscripten-core/emscripten/blob/main/src/settings.js>`_), this callback (which should be implemented on both the client and worker's ``Module`` object) allows sending custom messages and data between the web worker and the main thread (using the ``postCustomMessage`` function defined in `proxyClient.js <https://github.com/emscripten-core/emscripten/blob/main/src/proxyClient.js>`_ and `proxyWorker.js <https://github.com/emscripten-core/emscripten/blob/main/src/proxyWorker.js>`_).
165165

‎site/source/docs/api_reference/preamble.js.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
preamble.js
55
===========
66

7-
The JavaScript APIs in `preamble.js <https://github.com/emscripten-core/emscripten/blob/master/src/preamble.js>`_ provide programmatic access for interacting with the compiled C code, including: calling compiled C functions, accessing memory, converting pointers to JavaScript ``Strings`` and ``Strings`` to pointers (with different encodings/formats), and other convenience functions.
7+
The JavaScript APIs in `preamble.js <https://github.com/emscripten-core/emscripten/blob/main/src/preamble.js>`_ provide programmatic access for interacting with the compiled C code, including: calling compiled C functions, accessing memory, converting pointers to JavaScript ``Strings`` and ``Strings`` to pointers (with different encodings/formats), and other convenience functions.
88

99
We call this "``preamble.js``" because Emscripten's output JS, at a high level, contains the preamble (from ``src/preamble.js``), then the compiled code, then the postamble. (In slightly more detail, the preamble contains utility functions and setup, while the postamble connects things and handles running the application.)
1010

‎site/source/docs/api_reference/val.h.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ val.h (under-construction)
66

77
.. COMMENT (Not rendered) : This created from val.h header file on 10 Aug 2014-03
88
9-
The *Embind* C++ class :cpp:class:`emscripten::val` (defined in `val.h <https://github.com/emscripten-core/emscripten/blob/master/system/include/emscripten/val.h>`_) is used to *transliterate* JavaScript code to C++.
9+
The *Embind* C++ class :cpp:class:`emscripten::val` (defined in `val.h <https://github.com/emscripten-core/emscripten/blob/main/system/include/emscripten/val.h>`_) is used to *transliterate* JavaScript code to C++.
1010

1111
Guide material for this class can be found in :ref:`embind-val-guide`.
1212

‎site/source/docs/building_from_source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Building Emscripten yourself is an alternative to getting binaries using the ems
88

99
Emscripten's core codebase, which is in the main "emscripten" repo, does not need to be compiled (it uses Python for most of the scripting that glues together all the tools). What do need to be compiled are LLVM (which in particular provides clang and wasm-ld) and Binaryen. After compiling them, simply edit the ``.emscripten`` file to point to the right place for each of those tools (if the file doesn't exist yet, run ``emcc`` for the first time).
1010

11-
Get the ``master`` branches, or check the `Packaging <https://github.com/emscripten-core/emscripten/blob/master/docs/packaging.md>`_ instructions to identify precise commits in existing releases.
11+
Get the ``master`` branches, or check the `Packaging <https://github.com/emscripten-core/emscripten/blob/main/docs/packaging.md>`_ instructions to identify precise commits in existing releases.
1212

1313

1414
Building LLVM

‎site/source/docs/building_from_source/verify_emscripten_environment.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,6 @@ Other common problems to check for are:
9090

9191
- Errors in the paths in :ref:`.emscripten <compiler-configuration-file>`. These are less likely if you update the file using :ref:`emsdk <emsdk>`.
9292
- Using older versions of Node or JavaScript engines. Use the default versions for the SDK as listed with :ref:`emsdk list <emsdk>`.
93-
- Using older versions of LLVM. The correct versions come with the SDK, but if you're building the environment from source you should make sure to use the proper version of LLVM (which you can find using the `emscripten-releases DEPS file and history <https://github.com/emscripten-core/emscripten/blob/master/docs/process.md#release-processes>`_; other versions might work, especially close-by ones, but are not tested by us and so not guaranteed to work).
93+
- Using older versions of LLVM. The correct versions come with the SDK, but if you're building the environment from source you should make sure to use the proper version of LLVM (which you can find using the `emscripten-releases DEPS file and history <https://github.com/emscripten-core/emscripten/blob/main/docs/process.md#release-processes>`_; other versions might work, especially close-by ones, but are not tested by us and so not guaranteed to work).
9494

9595
If none of the above is helpful, then please :ref:`contact us <contact>` for help.

0 commit comments

Comments
 (0)
Please sign in to comment.