<div dir="ltr"><div>Updated as per changes to version.cmake files based on patch review by <a class="gmail_plusreply" id="plusReplyChip-0" href="mailto:aruna@multicorewareinc.com" tabindex="-1">@Aruna Matheswaran</a> </div><div><br></div>From 4b7f7997e9eab918f9c7d32971609e5fe1c19796 Mon Sep 17 00:00:00 2001<br>From: Srikanth Kurapati <<a href="mailto:srikanth.kurapati@multicorewareinc.com">srikanth.kurapati@multicorewareinc.com</a>><br>Date: Wed, 14 Oct 2020 13:40:10 +0530<br>Subject: [PATCH] Wiki changes for x265 Release 3.5<br><br>Archival procedure updates plus general edits in home and contribute pages<br>---<br> Contribute.md | 14 +++++------<br> Home.md       | 70 +++++++++++++++++++++++++++++++++++++++++++++------<br> 2 files changed, 69 insertions(+), 15 deletions(-)<br><br>diff --git a/Contribute.md b/Contribute.md<br>index 5fd299c..168c699 100644<br>--- a/Contribute.md<br>+++ b/Contribute.md<br>@@ -13,7 +13,7 @@ We use a mailing list to communicate and review patches:<br> <br> ## Contributor License Agreement ##<br> <br>-As is common for Open Source projects, we require a signed [contributor agreement](<a href="https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf">https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf</a>)<br>+As is common for Open Source Projects, we require a signed [contributor agreement](<a href="https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf">https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf</a>)<br> before we can accept changes.  This protects the project from being sued by former<br> contributors (or their employers) for copyright or patent infringement.<br> <br>@@ -142,12 +142,12 @@ Once your patch is approved and pushed to the x265 Git repository, we have autom<br> <br> If you introduce a new x265_param member, you must add documentation for it and make it fully configurable.<br> <br>-1. x265.h needs good documentation<br>+1. x265.h needs good documentation in comments in the param data structures.<br> 2. x265_param_parse() must be updated<br> 3. x265_param2string() must be updated<br>-4. getopt() (and CLI help) support needs to be added to x265cli.h<br>-5. the param must be documented in doc/reST/cli.rst<br>-6. X265_BUILD must be incremented, the binary interface has changed<br>-7. test(s) have to be added to smoke-tests.txt and regression-tests.txt<br>+4. getopt() (and CLI help) support needs to be added to x265cli.h and cpp files<br>+5. The param option usage and relevance must be documented in doc/reST/cli.rst and corresponding rst documentation files.<br>+6. X265_BUILD must be incremented, as the binary interface has changed.<br>+7. TestCases have to be added to smoke-tests.txt and regression-tests.txt.<br> <br>-Much of the above is also true if you change any public function definitions or public structures.<br>\ No newline at end of file<br>+Much of the above is also true if you change any public function definitions or public structures available as part of API to the library.<br>\ No newline at end of file<br>diff --git a/Home.md b/Home.md<br>index 8f36e14..21c0cb5 100644<br>--- a/Home.md<br>+++ b/Home.md<br>@@ -25,13 +25,69 @@ MD5 (x265_3.1.2.tar.gz) = a528ab27660d6bcfc46188ae602b3c2e<br> MD5 (x265_3.2.tar.gz) = 374e6359a00d17fd82195c02c341c861<br> MD5 (x265_3.2.1.tar.gz) = 94808045a34d88a857e5eaf3f68f4bca<br> ```<br>+# Preparing Git Release tar balls<br>+<br>+Source release tar balls can be created by the following procedure displayed below.<br>+<br>+$ pwd<br>+D:\Projects\x265_v3.5<br>+$ ls x265version.txt<br>+x265version.txt<br>+<br>+In case of absence of file<br>+$ touch x265version.txt<br>+$ vi x265version.txt<br>+<br>+## HOW TO POPULATE THE FILE ##<br>+```<br>+The purpose of the file is to statically maintain version information for archived repositories.<br>+A line in the file providies the information in key value pairs format <Key: Value>. The following<br>+mandatory set of key pairs are required for complete display of version string on the console. <br>+## VERSION INFORMATION FORMAT ##<br>+## Name: Values ##<br>+releasetag: refers to latest version tag for customers, users, developers and contributors in stadard format [Release_x.x] or x.x_RC[number]<br>+releasetagcommitid: provides git generated SHA-1 key changeset string of release tag<br>+releasetagdistance: number of updates indicating the number of commits from the release tag indicating the point at which is archival is done.<br>+repositorychangeset: is a git generated SHA-1 key changeset string of the commit at which archival is done<br>+<br>+EXAMPLES:<br>+For tar ball generation of Release Tag.<br>+## Name: Values ##<br>+releasetag: Release_3.4<br>+releasetagcommitid: a82c6c7<br>+repositorychangeset: a82c6c7<br>+releasetagdistance: 0<br>+<br>+When archives genearated after Release for customers, users etc..<br>+<br>+## Name: Values ##<br>+releasetag: Release_3.5<br>+releasetagcommitid: af23ad2<br>+releasetagdistance: 28<br>+repositorychangeset: a82c6c7<br>+<br>+For archival at a commit before the latest tag.<br>+<br>+## Name: Values ##<br>+releasetag: Release_3.5<br>+releasetagcommitid: af2c6c7<br>+releasetagdistance: -1<br>+repositorychangeset: af23ad2<br>+<br>+After filling the x265version file for git repositories and saving the same.<br>+$git archive --format=tar.gz -o x265-3.5.tar.gz --prefix=x265-test/ HEAD<br>+<br>+In case of multiple entries for the release information attribute value pairs. The latest of the set of required attribute value pairs in file will be considered.<br>+The same file can be appended at the end for every release. In order to prepare archives for various tags user can provides tagname instead of head or reference commitid.<br>+Please refer to [documentation](<a href="https://x265.readthedocs.io/en/master/">https://x265.readthedocs.io/en/master/</a>) for version option details.<br>+```<br> <br> # Building x265<br> <br>-To compile x265 you must first install Git and [CMake](<a href="http://www.cmake.org/cmake/resources/software.html">http://www.cmake.org/cmake/resources/software.html</a>) 2.8.8 or later.<br>+To compile x265 you must first install Git (for live repositories) and [CMake](<a href="http://www.cmake.org/cmake/resources/software.html">http://www.cmake.org/cmake/resources/software.html</a>) 2.8.8 or later.<br> To ensure your build of x265 is capable of full performance, install<br> [YASM](<a href="http://www.tortall.net/projects/yasm/releases">http://www.tortall.net/projects/yasm/releases</a>) 1.2.0 or newer if you are using x265 v2.6 or older, or<br>-[NASM](<a href="http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D">http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D</a>) 2.13 or newer if you are compiling from the default branch to compile<br>+[NASM](<a href="http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D">http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D</a>) 2.13 or newer if you are compiling from the master branch to compile<br> assembly primitives.  Then follow these easy steps:<br> <br> For detailed instructions, consult our build [README](<a href="https://bitbucket.org/multicoreware/x265_git/src/master/build/README.txt">https://bitbucket.org/multicoreware/x265_git/src/master/build/README.txt</a>).  Basic instructions are outlined below.<br>@@ -46,11 +102,10 @@ $ sudo apt-get install git-all cmake cmake-curses-gui build-essential yasm<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git">https://bitbucket.org/multicoreware/x265_git.git</a><br> $ cd x265/build/linux<br> $ ./make-Makefiles.bash<br>-$ make<br>+$ make -j8 <br> ```<br>-<br>-The primary target that we support is x86. x265 can also be built on linux platforms on ARM and POWERPC targets using the same build insructions above<br>-(exclude yasm from the list of packages on these targets). Our support for these platforms is growing as our user base on these platforms increase.<br>+The primary target hardware architecture that we support is x86. x265 can also be built on linux platforms on ARM and POWERPC target machines using the same build insructions above<br>+(exclude yasm from the list of packages on these target platforms). Our support for these platforms is growing as our user base on these platforms is increasing.<br> <br> We also support cross-compilation for ARM targets from linux platforms on x86 targets by using the g++ arm cross-compiler. This has been tested on Ubuntu linux<br> 14.04 running on an x86 CPU. On other distributions, package names and names of cross compilation tools may differ. This is an experimental feature, and has undergone very limited testing. <br>@@ -60,13 +115,12 @@ $ sudo apt-get install git-all cmake cmake-curses-gui build-essential gcc-arm-li<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git">https://bitbucket.org/multicoreware/x265_git.git</a><br> $ cd x265/build/arm-linux<br> $ ./make-Makefiles.bash<br>-$ make<br>+$ make -j8<br> ```<br> ## Windows (Visual Studio) Instructions ##<br> ```<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git">https://bitbucket.org/multicoreware/x265_git.git</a><br> ```<br>-<br> Then run make-solutions.bat in the build\ folder that corresponds to<br> your favorite compiler, configure your build options, click 'configure',<br> click 'generate', then close cmake-gui.  You will be rewarded with an<br>-- <br>2.20.1.windows.1<br><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Sun, Oct 18, 2020 at 4:52 PM Srikanth Kurapati <<a href="mailto:srikanth.kurapati@multicorewareinc.com">srikanth.kurapati@multicorewareinc.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">From 940c34742e5f94ef3929c214bed221815940662b Mon Sep 17 00:00:00 2001<br>From: Srikanth Kurapati <<a href="mailto:srikanth.kurapati@multicorewareinc.com" target="_blank">srikanth.kurapati@multicorewareinc.com</a>><br>Date: Wed, 14 Oct 2020 13:40:10 +0530<br>Subject: [PATCH] Wiki changes for x265 Release 3.5<br><br>Archival procedure updates plus general edits in home and contribute pages<br>---<br> Contribute.md | 14 ++++++------<br> Home.md       | 60 ++++++++++++++++++++++++++++++++++++++++++++-------<br> 2 files changed, 59 insertions(+), 15 deletions(-)<br><br>diff --git a/Contribute.md b/Contribute.md<br>index 5fd299c..168c699 100644<br>--- a/Contribute.md<br>+++ b/Contribute.md<br>@@ -13,7 +13,7 @@ We use a mailing list to communicate and review patches:<br> <br> ## Contributor License Agreement ##<br> <br>-As is common for Open Source projects, we require a signed [contributor agreement](<a href="https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf" target="_blank">https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf</a>)<br>+As is common for Open Source Projects, we require a signed [contributor agreement](<a href="https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf" target="_blank">https://bitbucket.org/multicoreware/x265_git/downloads/x265ContributorAgreement.pdf</a>)<br> before we can accept changes.  This protects the project from being sued by former<br> contributors (or their employers) for copyright or patent infringement.<br> <br>@@ -142,12 +142,12 @@ Once your patch is approved and pushed to the x265 Git repository, we have autom<br> <br> If you introduce a new x265_param member, you must add documentation for it and make it fully configurable.<br> <br>-1. x265.h needs good documentation<br>+1. x265.h needs good documentation in comments in the param data structures.<br> 2. x265_param_parse() must be updated<br> 3. x265_param2string() must be updated<br>-4. getopt() (and CLI help) support needs to be added to x265cli.h<br>-5. the param must be documented in doc/reST/cli.rst<br>-6. X265_BUILD must be incremented, the binary interface has changed<br>-7. test(s) have to be added to smoke-tests.txt and regression-tests.txt<br>+4. getopt() (and CLI help) support needs to be added to x265cli.h and cpp files<br>+5. The param option usage and relevance must be documented in doc/reST/cli.rst and corresponding rst documentation files.<br>+6. X265_BUILD must be incremented, as the binary interface has changed.<br>+7. TestCases have to be added to smoke-tests.txt and regression-tests.txt.<br> <br>-Much of the above is also true if you change any public function definitions or public structures.<br>\ No newline at end of file<br>+Much of the above is also true if you change any public function definitions or public structures available as part of API to the library.<br>\ No newline at end of file<br>diff --git a/Home.md b/Home.md<br>index 8f36e14..e72853e 100644<br>--- a/Home.md<br>+++ b/Home.md<br>@@ -25,13 +25,59 @@ MD5 (x265_3.1.2.tar.gz) = a528ab27660d6bcfc46188ae602b3c2e<br> MD5 (x265_3.2.tar.gz) = 374e6359a00d17fd82195c02c341c861<br> MD5 (x265_3.2.1.tar.gz) = 94808045a34d88a857e5eaf3f68f4bca<br> ```<br>+# Preparing Git Release tar balls<br> <br>+Source release tar balls can be created by the following procedure displayed below.<br>+<br>+$ pwd<br>+D:\Projects\x265_v3.5<br>+$ ls x265version.txt<br>+x265version.txt<br>+<br>+In case of absence of file<br>+$ touch x265version.txt<br>+$ vi x265version.txt<br>+<br>+## HOW TO POPULATE THE FILE ##<br>+```<br>+The purpose of the file is to statically maintain version information for archived repositories.<br>+A line in the file providies the information in key value pairs format <Key: Value>. The following<br>+set of key pairs are required for complete display of version string on the console. <br>+## VERSION INFORMATION FORMAT ##<br>+## Name: Values ##<br>+releasetag: refers to latest version tag for customers, users, developers and contributors in stadard format [x.x]+ or x.x_RC[number]<br>+releasetagcommitid: provides git generated SHA-1 key changeset string of release tag<br>+releasetagdistance: a whole number of updates attop of release for customer support and quality assurance<br>+repositorychangeset: is a git generated SHA-1 key changeset string of latest commit (OPTIONAL FOR release tagging)<br>+<br>+EXAMPLES:<br>+For tar ball generation of Release Tag.<br>+## Name: Values ##<br>+releasetag: 3.4<br>+releasetagcommitid: a82c6c7<br>+repositorychangeset: a82c6c7<br>+releasetagdistance: 0<br>+<br>+When archives genearated after Release for customers, users etc..<br>+<br>+## Name: Values ##<br>+releasetag: 3.5<br>+releasetagcommitid: af23ad2<br>+releasetagdistance: 28<br>+repositorychangeset: a82c6c7<br>+<br>+After filling the x265version file for git repositories and saving the same.<br>+$git archive --format=tar.gz -o x265-3.5.tar.gz --prefix=x265-test/ HEAD<br>+<br>+In case of multiple entries for the release information attribute value pairs. The latest of the set of required attributes in file will be considered.<br>+In order to prepare archives for various tag user can provides tagname instead of head or reference commitid. Please refer to [documentation](<a href="https://x265.readthedocs.io/en/master/" target="_blank">https://x265.readthedocs.io/en/master/</a>) for version option details.<br>+```<br> # Building x265<br> <br>-To compile x265 you must first install Git and [CMake](<a href="http://www.cmake.org/cmake/resources/software.html" target="_blank">http://www.cmake.org/cmake/resources/software.html</a>) 2.8.8 or later.<br>+To compile x265 you must first install Git (for live repositories) and [CMake](<a href="http://www.cmake.org/cmake/resources/software.html" target="_blank">http://www.cmake.org/cmake/resources/software.html</a>) 2.8.8 or later.<br> To ensure your build of x265 is capable of full performance, install<br> [YASM](<a href="http://www.tortall.net/projects/yasm/releases" target="_blank">http://www.tortall.net/projects/yasm/releases</a>) 1.2.0 or newer if you are using x265 v2.6 or older, or<br>-[NASM](<a href="http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D" target="_blank">http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D</a>) 2.13 or newer if you are compiling from the default branch to compile<br>+[NASM](<a href="http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D" target="_blank">http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D</a>) 2.13 or newer if you are compiling from the master branch to compile<br> assembly primitives.  Then follow these easy steps:<br> <br> For detailed instructions, consult our build [README](<a href="https://bitbucket.org/multicoreware/x265_git/src/master/build/README.txt" target="_blank">https://bitbucket.org/multicoreware/x265_git/src/master/build/README.txt</a>).  Basic instructions are outlined below.<br>@@ -46,11 +92,10 @@ $ sudo apt-get install git-all cmake cmake-curses-gui build-essential yasm<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git" target="_blank">https://bitbucket.org/multicoreware/x265_git.git</a><br> $ cd x265/build/linux<br> $ ./make-Makefiles.bash<br>-$ make<br>+$ make -j8 <br> ```<br>-<br>-The primary target that we support is x86. x265 can also be built on linux platforms on ARM and POWERPC targets using the same build insructions above<br>-(exclude yasm from the list of packages on these targets). Our support for these platforms is growing as our user base on these platforms increase.<br>+The primary target hardware architecture that we support is x86. x265 can also be built on linux platforms on ARM and POWERPC target machines using the same build insructions above<br>+(exclude yasm from the list of packages on these target platforms). Our support for these platforms is growing as our user base on these platforms is increasing.<br> <br> We also support cross-compilation for ARM targets from linux platforms on x86 targets by using the g++ arm cross-compiler. This has been tested on Ubuntu linux<br> 14.04 running on an x86 CPU. On other distributions, package names and names of cross compilation tools may differ. This is an experimental feature, and has undergone very limited testing. <br>@@ -60,13 +105,12 @@ $ sudo apt-get install git-all cmake cmake-curses-gui build-essential gcc-arm-li<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git" target="_blank">https://bitbucket.org/multicoreware/x265_git.git</a><br> $ cd x265/build/arm-linux<br> $ ./make-Makefiles.bash<br>-$ make<br>+$ make -j8<br> ```<br> ## Windows (Visual Studio) Instructions ##<br> ```<br> $ git clone <a href="https://bitbucket.org/multicoreware/x265_git.git" target="_blank">https://bitbucket.org/multicoreware/x265_git.git</a><br> ```<br>-<br> Then run make-solutions.bat in the build\ folder that corresponds to<br> your favorite compiler, configure your build options, click 'configure',<br> click 'generate', then close cmake-gui.  You will be rewarded with an<br>-- <br>2.20.1.windows.1<br><br><div><br></div>-- <br><div dir="ltr"><div dir="ltr"><b style="background-color:rgb(255,255,255)"><font color="#0b5394">With Regards,</font></b><div><b style="background-color:rgb(255,255,255)"><font color="#0b5394">Srikanth Kurapati.</font></b></div></div></div></div>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr"><b style="background-color:rgb(255,255,255)"><font color="#0b5394">With Regards,</font></b><div><b style="background-color:rgb(255,255,255)"><font color="#0b5394">Srikanth Kurapati.</font></b></div></div></div>