Skip to content

Commit

Permalink
Remove/update some references to incoming. (#10611)
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored Mar 2, 2020
1 parent 5825a1b commit 19801b7
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@ Other common problems to check for are:

- Errors in the paths in :ref:`.emscripten <compiler-configuration-file>`. These are less likely if you update the file using :ref:`emsdk <emsdk>`.
- Using older versions of Node or JavaScript engines. Use the default versions for the SDK as listed with :ref:`emsdk list <emsdk>`.
- 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/incoming/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).
- 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).

If none of the above is helpful, then please :ref:`contact us <contact>` for help.
4 changes: 2 additions & 2 deletions site/source/docs/contributing/AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
AUTHORS
=======

The `AUTHORS <https://github.com/emscripten-core/emscripten/blob/incoming/AUTHORS>`_ file lists everyone who has contributed to Emscripten.
The `AUTHORS <https://github.com/emscripten-core/emscripten/blob/master/AUTHORS>`_ file lists everyone who has contributed to Emscripten.

.. note :: Authors must add themselves to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/incoming/AUTHORS>`_ file (**incoming** branch) before :doc:`contributing <contributing>`. This act licenses their changes under the project’s :ref:`open source licenses (MIT/LLVM) <emscripten-license>`. Note that the developer retains copyright.
.. note :: Authors must add themselves to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/master/AUTHORS>`_ file (**master** branch) before :doc:`contributing <contributing>`. This act licenses their changes under the project’s :ref:`open source licenses (MIT/LLVM) <emscripten-license>`. Note that the developer retains copyright.
The contributors for releases up to Emscripten |release| inclusive (|today|) are listed below.

Expand Down
10 changes: 3 additions & 7 deletions site/source/docs/contributing/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ Repositories and branches of interest
=====================================

The Emscripten main repository is https://github.com/emscripten-core/emscripten.
The main branch is **incoming**, which exists for historic reasons as we did
not always have good pre-commit CI, and so we landed code on incoming first,
tested, then merged to master. Today we have extensive pre-commit CI on GitHub,
so the incoming branch functions like the master branch in most projects.

Aside from the Emscripten repo, the other codebases of interest are LLVM
and Binaryen, which Emscripten invokes, and
Expand All @@ -51,13 +47,13 @@ and Binaryen, which Emscripten invokes, and
Submitting patches
==================

Patches should be submitted as *pull requests* to the **incoming** branch.
Patches should be submitted as *pull requests* to the **master** branch.

.. note:: Before submitting your first patch, add yourself to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/incoming/AUTHORS>`_ file. By doing so, you agree to license your code under the project's :ref:`open source licenses (MIT/LLVM) <emscripten-license>`.
.. note:: Before submitting your first patch, add yourself to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/master/AUTHORS>`_ file. By doing so, you agree to license your code under the project's :ref:`open source licenses (MIT/LLVM) <emscripten-license>`.

When submitting patches, please:

- Make pull requests to **incoming**, not master.
- Make pull requests to **master**.
- Add an automatic test if you add any new functionality or fix a bug. Search
in ``tests/*.py`` for related tests, as often the simplest thing is to add to
an existing one. If you're not sure how to test your code, feel free to ask
Expand Down
4 changes: 2 additions & 2 deletions site/source/docs/getting_started/downloads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Download and install
`Chromium CI <https://ci.chromium.org/p/emscripten-releases>`_). (While we
don't officially support other ways of getting Emscripten, we definitely
appreciate the efforts by third parties to
`package Emscripten <https://github.com/emscripten-core/emscripten/blob/incoming/docs/process.md#packaging-emscripten>`_
`package Emscripten <https://github.com/emscripten-core/emscripten/blob/master/docs/process.md#packaging-emscripten>`_
for users' convenience, and we'd like to help out, please get in touch if
you are such a packager!)

Expand Down Expand Up @@ -86,7 +86,7 @@ You can also specify which backend you want to use, either ``fastcomp`` or ``ups
./emsdk install 1.38.45-fastcomp


There are also "tip-of-tree builds", which are the very latest code that passes integration tests on `Chromium CI <https://ci.chromium.org/p/emscripten-releases>`_. This is updated much more frequently than tagged releases, but may be less stable (we `tag releases manually <https://github.com/emscripten-core/emscripten/blob/incoming/docs/process.md#minor-version-updates-1xy-to-1xy1>`_ using a more careful procedure). Tip-of-tree builds may be useful for continuous integration that uses the emsdk (as Emscripten's GitHub CI does), and you may want to use it in your own CI as well, so that if you find a regression on your project you can report it and prevent it from reaching a tagged release. Tip-of-builds may also be useful if you want to test a feature that just landed but didn't reach a release yet. To use a tip-of-tree build, use the ``tot`` target, and note that you must specify the backend explicitly,
There are also "tip-of-tree builds", which are the very latest code that passes integration tests on `Chromium CI <https://ci.chromium.org/p/emscripten-releases>`_. This is updated much more frequently than tagged releases, but may be less stable (we `tag releases manually <https://github.com/emscripten-core/emscripten/blob/master/docs/process.md#minor-version-updates-1xy-to-1xy1>`_ using a more careful procedure). Tip-of-tree builds may be useful for continuous integration that uses the emsdk (as Emscripten's GitHub CI does), and you may want to use it in your own CI as well, so that if you find a regression on your project you can report it and prevent it from reaching a tagged release. Tip-of-builds may also be useful if you want to test a feature that just landed but didn't reach a release yet. To use a tip-of-tree build, use the ``tot`` target, and note that you must specify the backend explicitly,

::

Expand Down
2 changes: 1 addition & 1 deletion site/source/docs/getting_started/test-suite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Emscripten Test Suite
=====================

Emscripten has a comprehensive test suite, which covers virtually all Emscripten functionality. These tests are an excellent resource for developers as they provide practical examples of most features, and are known to pass on the master branch (and almost always on the incoming branch). In addition to correctness tests, there are also benchmarks that you can run.
Emscripten has a comprehensive test suite, which covers virtually all Emscripten functionality. These tests are an excellent resource for developers as they provide practical examples of most features, and are known to pass on the master branch. In addition to correctness tests, there are also benchmarks that you can run.

This article explains how to run the test and benchmark suite, and provides an overview of what tests are available.

Expand Down
3 changes: 1 addition & 2 deletions site/source/docs/introducing_emscripten/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ information. The easiest way to find these posts is to use `this search
ChangeLog
=========

The ChangeLog for Emscripten |release| (|today|) is listed below (incoming version
`here <https://github.com/emscripten-core/emscripten/blob/incoming/ChangeLog.md>`_).
The ChangeLog for Emscripten |release| (|today|) is listed below.

.. include:: ../../../../ChangeLog.md
:literal:

0 comments on commit 19801b7

Please sign in to comment.