[PATCH] D80395: HowToReleaseLLVM: Clean up document and remove references to SVN

[Hans Wennborg via Phabricator via llvm-commits]

hans edited reviewers, added: hans; removed: hansw.
hans added a comment.

Thanks! This doc could certainly use some attention :-) I put some comments, feel free to ignore if you don't want to get into all of them now.



================
Comment at: llvm/docs/HowToReleaseLLVM.rst:75
 
 Create Release Branch
 ^^^^^^^^^^^^^^^^^^^^^
----------------
Actually, I always bump the trunk version number before creating the branch, and then create the branch from the commit right before the version number bump. So the dance is more like:

1. Bump trunk version (and also clear release notes; not necessarily in the same commit)
2. Create release branch from right before the bump
3. Drop "git" prefix on the git branch.

Also the version bump gets tagged with "llvmorg-x-init" to generate nice "git describe" results.


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:78
 
-Branch the Subversion trunk using the following procedure:
+Branch the Git trunk using the following procedure:
 
----------------
Maybe note somewhere that the same should be done for the 'test-suite' repo, since the test and export scripts expect it to be versioned similarly.


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:295
 
-The ``utils/release/merge.sh`` script can be used to merge individual revisions
-into any one of the llvm projects. To merge revision ``$N`` into project
-``$PROJ``, do:
+Use the git cherry-pick command to merge patches to the release branch:
 
----------------
maybe "use the git cherry-pick command with the -x option" to really spell it out so people don't forget the -x part.


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:316
 Subversion and changes in basic system requirements.  Merge both changes from
 mainline into the release branch.
 
----------------
"Merge both changes from mainline into the release branch." sounds wrong. The changes should be done on the release branch directly.


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:317
 mainline into the release branch.
 
 .. _tag:
----------------
One thing that's easy to miss is that some docs must be generated. This is my go-to command for that:


```
        bin/clang-tblgen -gen-diag-docs -I../clang/include \
              -I../clang/include/clang/Basic/ \
              ../clang/include/clang/Basic/Diagnostic.td -o \
              ../clang/docs/DiagnosticsReference.rst && \
        bin/clang-tblgen -gen-attr-docs -I../clang/include \
                ../clang/include/clang/Basic/Attr.td -o \
                ../clang/docs/AttributeReference.rst && \
        bin/clang-tblgen -gen-opt-docs -I../clang/include \
                -I../clang/include/clang/Driver -I../llvm/include \
                ../clang/include/clang/Driver/ClangOptionDocs.td -o \
                ../clang/docs/ClangCommandLineReference.rst

```


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:327
 
-  $ ./tag.sh -release X.Y.Z -final
-
-Update the LLVM Demo Page
--------------------------
-
-The LLVM demo page must be updated to use the new release.  This consists of
-using the new ``clang`` binary and building LLVM.
+  $ git tag llvmog-X.Y.Z
+  $ git push https://github.com/llvm/llvm-project.git llvmorg-X.Y.Z
----------------
I've been doing "git tag -a", but I'm not sure if it makes any real difference?


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:340
 
-#. Commit the ``llvm``, ``test-suite``, ``clang`` source and binaries in this
-   new directory.
-
 #. Copy and commit the ``llvm/docs`` and ``LICENSE.txt`` files into this new
    directory.  The docs should be built with ``BUILD_FOR_WEBSITE=1``.
----------------
These steps seem to refer to things that don't exist anymore, like BUILD_FOR_WEBSITE=1. Maybe they can be written a bit less specific: like check in the docs, update download.html to link to the binaries on github, etc. etc.


================
Comment at: llvm/docs/HowToReleaseLLVM.rst:353
    new release and release announcement.  Make sure this all gets committed back
    into Subversion.
 
----------------
another Subversion mention here :-)


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D80395/new/

https://reviews.llvm.org/D80395