XRT governence changes (#3413)

* Update CHANGELOG
* Add Contributing file to guide PRs from community
* Minor update to Changelog
* Update release version in Sphinx conf file
* Add AUTHORS file
* Remove note about disabling multiprocess in multiprocess doc
* Updated XSA shell diagram with better layout
* Updates to security doc
* Deleted our copy of checkpatch.p; now automatically downloaded from kernel.org

Author: sonals

AUTHORS.rst

@@ -0,0 +1,22 @@
+===========
+XRT Authors
+===========
+
+This file lists authors who have either directly contributed to XRT code base or are authors
+of other open source projects which are used in XRT.
+
+* [email protected]
+* Peter Korsgaard <[email protected]>
+* Secret Lab Technologies Ltd
+* Intel Corporation
+* David Gibson, IBM Corporation.
+* embedded brains GmbH
+* Kim Phillips, Freescale Semiconductor.
+* Free Electrons
+* NextThing Co.
+* Jan Stephan <[email protected]>
+* OSR Open Systems Resources, Inc
+* Michael Preston <[email protected]>
+* Jeff Baxter <[email protected]>
+* Samsung Semiconductor, Inc
+* The Khronos Group Inc

CHANGELOG.rst

@@ -9,7 +9,12 @@ Added
 
 * XRT native APIs for PL kernel have been added. These APIs are defined in new header file ``xrt_kernel.h``. Please see ``tests/xrt/22_verify/main.cpp`` and ``tests/xrt/02_simple/main.cpp`` for examples. The APIs are also accessible from python. Please see ``tests/python/22_verify/22_verify.py`` and ``tests/python/02_simple/main.py`` for examples.
 * Support for data-driven platforms have been added. XRT uses PCIe VSEC to identify data-driven platforms. For these class of platforms XRT uses device tree to discover IPs in the shell and then initialize them.
-* Experimental APIs have been added for AIE control for edge platforms. The APIs are defined in header file ``xrt_aie.h``
+* Experimental APIs have been added for AIE control for edge platforms. The APIs are defined in header file ``xrt_aie.h``.
+* Support for U30 video acceleration offload device has been added.
+* Early access versions of next generation utilities, *xbutil* and *xbmgmt* are available. They can be invoked via *--new* switch as ``xbutil --new``.
+* Utilties xbutil and xbmgmt now give a warning when they detect an unsupported Linux distribution version and kernel version.
+* Error code paths for clPollStreams() API has been improved.
+
 
 Removed
 .......
@@ -19,13 +24,14 @@ Removed
 * ``xclUpgradeFirmware()``, ``xclUpgradeFirmware2()`` and ``xclUpgradeFirmwareXSpi()`` have been marked as deprecated in this release and will be removed in a future release. Please use xbmgmt utility to flash device.
 * ``xclBootFPGA()``, ``xclRemoveAndScanFPGA()`` and ``xclRegisterInterruptNotify()`` have been marked as deprecated in this release and will be removed in a future release. These functionalities are no longer supported.
 * ``xclLockDevice()`` and ``xclUnlockDevice()`` have been marked as deprecated in this release and will be removed in a future release. These functionalities are no longer supported.
+* This is the last release of XMA legacy APIs. Please port your application to XMA2 APIs.
 
 Known Issues
 ............
 
 * On CentOS the ``xrtdeps.sh`` script used to install required dependencies for building XRT is trying to install no longer supported ``devtoolset-6``.  In order to build XRT on CentOS or RHEL, a later devtoolset version should be installed, for example ``devtoolset-9``.
 
-  
+
 2.4.0 (202010.2.4)
 ~~~~~~~~~~~~~~~~~~
 

CONTRIBUTING.rst

@@ -0,0 +1,95 @@
+===================
+Contributing to XRT
+===================
+
+
+Welcome to XRT! You can contribute to XRT in a variety of ways. You can report bugs and feature requests using `GitHub Issues <https://github.com/Xilinx/XRT/issues>`_. You can send patches which add new features to XRT or fix bugs in XRT. You can also send patches to update XRT documentation.
+
+
+Reporting Issues
+****************
+
+When reporting issues on GitHub please include the following:
+
+1. XRT version including git hash
+2. Alveo platform name and version
+3. Output of ``xbutil query``
+4. Output of ``xbmgmt scan``
+5. ``dmesg``
+6. gdb stack trace of host application
+7. Contents of xrt.ini (if used)
+
+
+Contributing Code
+*****************
+
+Please use GitHub Pull Requests (PR) for sending code contributions. When sending code sign your work as described below. Be sure to use the same license for your contributions as the current license of the XRT component you are contributing to.
+
+
+Sign Your Work
+==============
+
+Please use the *Signed-off-by* line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) defined by https://developercertificate.org/ reproduced below::
+
+  Developer Certificate of Origin
+  Version 1.1
+
+  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+  1 Letterman Drive
+  Suite D4700
+  San Francisco, CA, 94129
+
+  Everyone is permitted to copy and distribute verbatim copies of this
+  license document, but changing it is not allowed.
+
+
+  Developer's Certificate of Origin 1.1
+
+  By making a contribution to this project, I certify that:
+
+  (a) The contribution was created in whole or in part by me and I
+      have the right to submit it under the open source license
+      indicated in the file; or
+
+  (b) The contribution is based upon previous work that, to the best
+      of my knowledge, is covered under an appropriate open source
+      license and I have the right under that license to submit that
+      work with modifications, whether created in whole or in part
+      by me, under the same open source license (unless I am
+      permitted to submit under a different license), as indicated
+      in the file; or
+
+  (c) The contribution was provided directly to me by some other
+      person who certified (a), (b) or (c) and I have not modified
+      it.
+
+  (d) I understand and agree that this project and the contribution
+      are public and that a record of the contribution (including all
+      personal information I submit with it, including my sign-off) is
+      maintained indefinitely and may be redistributed consistent with
+      this project or the open source license(s) involved.
+
+
+Here is an example Signed-off-by line which indicates that the contributor accepts DCO::
+
+
+  This is my commit message
+
+  Signed-off-by: Jane Doe <[email protected]>
+
+
+Code License
+============
+
+All XRT code is licensed under the terms `LICENSE <https://github.com/Xilinx/XRT/blob/master/LICENSE>`_ Your contribution will be accepted under the same license.
+
+Please consult the table below for the brief summary of XRT license for various components.
+
+====================  =========================
+Component             License
+====================  =========================
+Linux xocl driver     GPLv2
+Linux xclmgmt driver  GPLv2
+Linux zocl driver     Dual GPLv2 and Apache 2.0
+User space            Apache 2.0
+====================  =========================

build/checkpatch.sh

@@ -3,4 +3,9 @@
 # Use this script to run checkpatch on argument file only
 
 BUILDDIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+if [ ! -x $BUILDDIR/checkpatch/checkpatch.pl ]; then
+    curl -o $BUILDDIR/checkpatch/checkpatch.pl "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/plain/scripts/checkpatch.pl?h=v4.14.180"
+    chmod +x $BUILDDIR/checkpatch/checkpatch.pl
+fi
+
 $BUILDDIR/checkpatch/checkpatch.pl --color=never --emacs --terse --no-tree --max-line-length=120 -f $1