From 2d45ebd0eba4879e56a82afec801eed44f7b4aa7 Mon Sep 17 00:00:00 2001 From: Kenichi Maehashi Date: Thu, 2 Mar 2023 09:25:21 +0000 Subject: [PATCH] update branch name from `master` to `main` --- .github/workflows/backport.yml | 2 +- .github/workflows/flexci.yml | 2 +- .pfnci/BRANCH | 2 +- .pfnci/linux/tests/actions/benchmark.sh | 6 +++--- .pre-commit-config.yaml | 4 ++-- README.md | 4 ++-- docs/source/conf.py | 2 +- docs/source/contribution.rst | 18 +++++++++--------- docs/source/user_guide/kernel.rst | 2 +- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml index 151b0d18c1f..179694d231e 100644 --- a/.github/workflows/backport.yml +++ b/.github/workflows/backport.yml @@ -4,7 +4,7 @@ on: pull_request_target: types: [closed, labeled] branches: - - master + - main jobs: backport: diff --git a/.github/workflows/flexci.yml b/.github/workflows/flexci.yml index 85b4b9bceb3..30466a47953 100644 --- a/.github/workflows/flexci.yml +++ b/.github/workflows/flexci.yml @@ -2,7 +2,7 @@ name: "FlexCI" on: push: - branches: ["master", "v[0-9]+", "hotfix-*"] + branches: ["main", "v[0-9]+", "hotfix-*"] issue_comment: types: [created] diff --git a/.pfnci/BRANCH b/.pfnci/BRANCH index 1f7391f92b6..ba2906d0666 100644 --- a/.pfnci/BRANCH +++ b/.pfnci/BRANCH @@ -1 +1 @@ -master +main diff --git a/.pfnci/linux/tests/actions/benchmark.sh b/.pfnci/linux/tests/actions/benchmark.sh index 7e537015a0c..452ec99c58c 100755 --- a/.pfnci/linux/tests/actions/benchmark.sh +++ b/.pfnci/linux/tests/actions/benchmark.sh @@ -12,7 +12,7 @@ python3 prof.py benchmarks/bench_ufunc_cupy.py -c mkdir target mv *.csv target/ -# Run benchmarks for master branch +# Run benchmarks for main branch # Since GCP instance may change and use diff gen processsors/GPUs # we just recompile and run to avoid false errors python3 -m pip uninstall -y cupy @@ -23,10 +23,10 @@ if [[ "${PULL_REQUEST:-}" == "" ]]; then # For branches we compare against the latest release # TODO(ecastill) find a programatical way of doing this # sorting tags, or just checking the dates may mix the - # stable & master branches + # stable & main branches git checkout tags/v11.0.0a2 -b v11.0.0a2 else - git checkout master + git checkout main fi git submodule update --init python3 -m pip install --user -v . diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 72f8c9706c8..14b2cd1710d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,8 +8,8 @@ repos: # Git - id: check-added-large-files - id: no-commit-to-branch - name: "ensure no direct commit to master/vXX branch" - args: [--branch, "master", --pattern, "v\\d+"] + name: "ensure no direct commit to main/vXX branch" + args: [--branch, "main", --pattern, "v\\d+"] - id: check-case-conflict # Contents - id: mixed-line-ending diff --git a/README.md b/README.md index a3441672298..d324f2ab898 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
# CuPy : NumPy & SciPy for GPU @@ -12,7 +12,7 @@ [**Website**](https://cupy.dev/) | [**Install**](https://docs.cupy.dev/en/stable/install.html) | [**Tutorial**](https://docs.cupy.dev/en/stable/user_guide/basic.html) -| [**Examples**](https://github.com/cupy/cupy/tree/master/examples) +| [**Examples**](https://github.com/cupy/cupy/tree/main/examples) | [**Documentation**](https://docs.cupy.dev/en/stable/) | [**API Reference**](https://docs.cupy.dev/en/stable/reference/) | [**Forum**](https://groups.google.com/forum/#!forum/cupy) diff --git a/docs/source/conf.py b/docs/source/conf.py index be8f7a583c8..0ab3dd19045 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,7 +28,7 @@ rtd_version = os.environ.get('READTHEDOCS_VERSION') if rtd_version == 'latest': - tag = 'master' + tag = 'main' else: tag = 'v{}'.format(__version__) extlinks = { diff --git a/docs/source/contribution.rst b/docs/source/contribution.rst index 9018369b3bd..b11a8422ac8 100644 --- a/docs/source/contribution.rst +++ b/docs/source/contribution.rst @@ -81,24 +81,24 @@ The GitHub milestone is basically used for collecting the issues and PRs resolve Git Branches ~~~~~~~~~~~~ -The ``master`` branch is used to develop pre-release versions. -It means that **alpha, beta, and RC updates are developed at the** ``master`` **branch**. +The ``main`` branch is used to develop pre-release versions. +It means that **alpha, beta, and RC updates are developed at the** ``main`` **branch**. This branch contains the most up-to-date source tree that includes features newly added after the latest major version. The stable version is developed at the individual branch named as ``vN`` where "N" reflects the version number (we call it a *versioned branch*). For example, v1.0.0, v1.0.1, and v1.0.2 will be developed at the ``v1`` branch. **Notes for contributors:** -When you send a pull request, you basically have to send it to the ``master`` branch. +When you send a pull request, you basically have to send it to the ``main`` branch. If the change can also be applied to the stable version, a core team member will apply the same change to the stable version so that the change is also included in the next revision update. -If the change is only applicable to the stable version and not to the ``master`` branch, please send it to the versioned branch. +If the change is only applicable to the stable version and not to the ``main`` branch, please send it to the versioned branch. We basically only accept changes to the latest versioned branch (where the stable version is developed) unless the fix is critical. -If you want to make a new feature of the ``master`` branch available in the current stable version, please send a *backport PR* to the stable version (the latest ``vN`` branch). +If you want to make a new feature of the ``main`` branch available in the current stable version, please send a *backport PR* to the stable version (the latest ``vN`` branch). See the next section for details. -*Note: a change that can be applied to both branches should be sent to the* ``master`` *branch.* +*Note: a change that can be applied to both branches should be sent to the* ``main`` *branch.* *Each release of the stable version is also merged to the development version so that the change is also reflected to the next major version.* Feature Backport PRs @@ -134,7 +134,7 @@ First of all, before starting to write any code, do not forget to confirm the fo - Read through the :ref:`coding-guide` and :ref:`testing-guide`. - Check the appropriate branch that you should send the PR following :ref:`contrib-git-branches`. - If you do not have any idea about selecting a branch, please choose the ``master`` branch. + If you do not have any idea about selecting a branch, please choose the ``main`` branch. In particular, **check the branch before writing any code.** The current source tree of the chosen branch is the starting point of your change. @@ -149,7 +149,7 @@ Note that this automatic PR test only includes CPU tests. .. note:: - We are also running continuous integration with GPU tests for the ``master`` branch and the versioned branch of the latest major version. + We are also running continuous integration with GPU tests for the ``main`` branch and the versioned branch of the latest major version. Since this service is currently running on our internal server, we do not use it for automatic PR tests to keep the server secure. If you are planning to add a new feature or modify existing APIs, **it is recommended to open an issue and discuss the design first.** @@ -389,7 +389,7 @@ When adding a new feature to the framework, you also need to document it in the If you are unsure about how to fix the documentation, you can submit a pull request without doing so. Reviewers will help you fix the documentation appropriately. -The documentation source is stored under `docs directory `_ and written in `reStructuredText `_ format. +The documentation source is stored under `docs directory `_ and written in `reStructuredText `_ format. To build the documentation, you need to install `Sphinx `_:: diff --git a/docs/source/user_guide/kernel.rst b/docs/source/user_guide/kernel.rst index a6814152066..b077886b220 100644 --- a/docs/source/user_guide/kernel.rst +++ b/docs/source/user_guide/kernel.rst @@ -381,7 +381,7 @@ It may be important to note that this dedicated memory bank is not shared with t For now, CuPy offers no helper routines to create user defined composite types. Such composite types can however be built recursively using NumPy dtype `offsets` and `itemsize` capabilities, -see `cupy/examples/custum_struct `_ for examples of advanced usage. +see `cupy/examples/custum_struct `_ for examples of advanced usage. .. warning:: You cannot directly pass static arrays as kernel arguments with the ``type arg[N]`` syntax where N is a compile time constant. The signature of ``__global__ void kernel(float arg[5])`` is seen as ``__global__ void kernel(float* arg)`` by the compiler. If you want to pass five floats to the kernel by value you need to define a custom structure ``struct float5 { float val[5]; };`` and modify the kernel signature to ``__global__ void kernel(float5 arg)``.