Merge pull request #441 from xmos/release_prep

v5.0.0 release prep

CHANGELOG.rst

@@ -47,15 +47,17 @@ lib_xua change log
 
     - lib_logging: 3.2.0 -> 3.3.1
 
-    - lib_mic_array: 4.6.0 -> 5.4.0
+    - lib_mic_array: 4.6.0 -> 5.5.0
 
     - lib_spdif: 6.1.1 -> 6.2.1
 
     - lib_sw_pll: 2.2.0 -> 2.3.1
 
     - lib_xassert: 4.2.0 -> 4.3.1
 
-    - lib_xcore_math: Added dependency 2.3.0
+    - lib_xcore_math: Added dependency 2.4.0
+
+    - lib_xud: 2.3.2 -> 2.4.0
 
 4.2.0
 -----

Jenkinsfile

@@ -15,6 +15,22 @@ def clone_test_deps() {
   }
 }
 
+def archiveLib(String repoName) {
+    sh "git -C ${repoName} clean -xdf"
+    sh "zip ${repoName}_sw.zip -r ${repoName}"
+    archiveArtifacts artifacts: "${repoName}_sw.zip", allowEmptyArchive: false
+}
+
+def checkout_shallow()
+{
+  checkout scm: [
+    $class: 'GitSCM',
+    branches: scm.branches,
+    userRemoteConfigs: scm.userRemoteConfigs,
+    extensions: [[$class: 'CloneOption', depth: 1, shallow: true, noTags: false]]
+  ]
+}
+
 getApproval()
 
 pipeline {
@@ -37,6 +53,12 @@ pipeline {
       name: 'XMOSDOC_VERSION',
       defaultValue: 'v6.1.3',
       description: 'The xmosdoc version')
+
+    string(
+      name: 'INFR_APPS_VERSION',
+      defaultValue: 'v2.0.1',
+      description: 'The infr_apps version'
+    )
   }
 
   stages {
@@ -49,18 +71,23 @@ pipeline {
           steps {
             println "Stage running on ${env.NODE_NAME}"
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("examples") {
                 withTools(params.TOOLS_VERSION) {
-                  sh 'cmake -G "Unix Makefiles" -B build'
+                  sh 'cmake -G "Unix Makefiles" -B build -DDEPS_CLONE_SHALLOW=TRUE'
                 }
               }
             }
-            warnError("Docs") {
-              runLibraryChecks("${WORKSPACE}/${REPO}", "v2.0.1")
+            warnError("lib checks") {
+              runLibraryChecks("${WORKSPACE}/${REPO}", "${params.INFR_APPS_VERSION}")
             }
           }
-        }  // Checkout and lib checks
+        }  // stage('Checkout and lib checks')
+        stage("Archive Lib") {
+          steps {
+            archiveLib(REPO)
+          }
+        } //stage("Archive Lib")
 
         stage('Build examples') {
           steps {
@@ -69,7 +96,7 @@ pipeline {
             dir("${REPO}") {
               dir("examples") {
                 withTools(params.TOOLS_VERSION) {
-                  sh 'cmake -G "Unix Makefiles" -B build'
+                  sh 'cmake -G "Unix Makefiles" -B build -DDEPS_CLONE_SHALLOW=TRUE'
                   sh 'xmake -C build -j 16'
                 }
               }
@@ -115,7 +142,7 @@ pipeline {
             println "Stage running on ${env.NODE_NAME}"
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("${REPO}/host/xmosdfu") {
                 sh 'cmake -B build'
                 sh 'make -C build'
@@ -140,7 +167,7 @@ pipeline {
             println "Stage running on ${env.NODE_NAME}"
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("${REPO}/host/xmosdfu") {
                 sh 'cmake -B build'
                 sh 'make -C build'
@@ -171,7 +198,7 @@ pipeline {
             println "Stage running on ${env.NODE_NAME}"
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("${REPO}/host/xmosdfu") {
                 sh 'cmake -B build'
                 sh 'make -C build'
@@ -199,7 +226,7 @@ pipeline {
             println "Stage running on ${env.NODE_NAME}"
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("${REPO}/host/xmosdfu") {
                 sh 'cmake -B build'
                 sh 'make -C build'
@@ -224,7 +251,7 @@ pipeline {
             println "Stage running on ${env.NODE_NAME}"
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
               dir("${REPO}/host/xmosdfu") {
                 withVS("vcvars32.bat") {
                   bat "cmake -B build -G Ninja"
@@ -260,7 +287,7 @@ pipeline {
           }
           steps {
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
 
               clone_test_deps()
 
@@ -310,7 +337,7 @@ pipeline {
             clone_test_deps()
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
             }
 
             dir("hardware_test_tools/xmosdfu") {
@@ -353,7 +380,7 @@ pipeline {
             clone_test_deps()
 
             dir("${REPO}") {
-              checkout scm
+              checkout_shallow()
             }
 
             dir("${REPO}/tests") {

README.rst

@@ -1,31 +1,35 @@
 :orphan:
 
 #####################################
-lib_xua: USB Audio Components Library
+lib_xua: USB Audio components library
 #####################################
 
 :vendor: XMOS
 :version: 5.0.0
 :scope: General Use
 :description: USB Audio components library
-:category: General Purpose
+:category: Audio
 :keywords: USB Audio, I2S, MIDI, HID, DFU
 :devices: xcore.ai, xcore-200
 
-********
-Overview
-********
+*******
+Summary
+*******
 
 ``lib_xua`` contains shared components for use in the XMOS USB Audio (XUA) Reference Designs.
 
 These components enable the development of USB Audio devices on the `XMOS xcore` architecture.
 
+.. tip::
+
+    Reference design applications that use `lib_xua` are located in `sw_usb_audio` folder of the
+    USB Audio reference design `download <https://www.xmos.com/develop/usb-multichannel-audio/>`_.
+    This is a typical entry point for most developers.
+
 ********
 Features
 ********
 
-Key features of the various components in this repository are as follows
-
 - USB Audio Class 1.0/2.0 compliant
 
 - Fully Asynchronous operation (synchronous mode as an option)
@@ -66,7 +70,7 @@ Note, not all features may be supported at all sample frequencies, simultaneousl
 Some features may also require specific host driver support.
 
 ************
-Known Issues
+Known issues
 ************
 
 - When in DSD mode with S/PDIF output enabled, DSD samples are transmitted over S/PDIF if the DSD and S/PDIF channels are shared, this may or may not be desired (#14762)
@@ -95,8 +99,14 @@ Development repo
 
   * `lib_xua <https://www.github.com/xmos/lib_xua>`_
 
+**************
+Required tools
+**************
+
+  * XMOS XTC Tools: 15.3.0
+
 ************************
-Host System Requirements
+Host system requirements
 ************************
 
 USB Audio devices built using `lib_xua` have the following host system requirements.
@@ -111,40 +121,32 @@ USB Audio devices built using `lib_xua` have the following host system requireme
 
 Older versions of Windows are not guaranteed to operate as expected. Devices are also expected to operate with various Linux distributions including mobile variants.
 
-**************
-Required Tools
-**************
-
-  * XMOS XTC Tools: 15.3.0
-
 *********************************
-Required Libraries (dependencies)
+Required libraries (dependencies)
 *********************************
 
-  * `lib_adat <https://www.github.com/xmos/lib_adat>`_
-  * `lib_locks <https://www.github.com/xmos/lib_locks>`_
-  * `lib_logging <https://www.github.com/xmos/lib_logging>`_
-  * `lib_mic_array <https://www.github.com/xmos/lib_mic_array>`_
-  * `lib_xassert <https://www.github.com/xmos/lib_xassert>`_
-  * `lib_xcore_math <https://www.github.com/xmos/lib_xcore_math>`_
-  * `lib_spdif <https://www.github.com/xmos/lib_spdif>`_
-  * `lib_sw_pll <https://www.github.com/xmos/lib_sw_pll>`_
-  * `lib_xud <https://www.github.com/xmos/lib_xud>`_
-
+  * `lib_adat <https://www.xmos.com/file/lib_adat>`_
+  * `lib_locks <https://www.xmos.com/file/lib_locks>`_
+  * `lib_logging <https://www.xmos.com/file/lib_logging>`_
+  * `lib_mic_array <https://www.xmos.com/file/lib_mic_array>`_
+  * `lib_xassert <https://www.xmos.com/file/lib_xassert>`_
+  * `lib_xcore_math <https://www.xmos.com/file/lib_xcore_math>`_
+  * `lib_spdif <https://www.xmos.com/file/lib_spdif>`_
+  * `lib_sw_pll <https://www.xmos.com/file/lib_sw_pll>`_
+  * `lib_xud <https://www.xmos.com/file/lib_xud>`_
 
 *************************
-Related Application Notes
+Related application notes
 *************************
 
 The following application notes use this library:
 
-  * AN000246 - Simple USB Audio Device using lib_xua
-  * AN000247 - Using lib_xua with lib_spdif (transmit)
-  * AN000248 - Using lib_xua with lib_mic_array
-  * AN02019: Using Device Firmware Upgrade (DFU) for USB Audio
+  * `AN02019: Using Device Firmware Upgrade (DFU) for USB Audio` <www.xmos.com/file/an02019>`_
 
 *******
 Support
 *******
 
-This package is supported by XMOS Ltd. Issues can be raised against the software at http://www.xmos.com/support
+This package is supported by XMOS Ltd. Issues can be raised against the software at
+`http://www.xmos.com/support <http://www.xmos.com/support>`_
+

doc/Doxyfile.inc

@@ -1,7 +1,7 @@
 # This file provides overrides to the Doxyfile configuration
 
 PROJECT_NAME           = lib_xua
-PROJECT_BRIEF          = "XUA library"
+PROJECT_BRIEF          = "USB Audio components library"
 
 INPUT                  = ../lib_xua/api ../lib_xua/src/core/user/audiostream ../lib_xua/src/core/user/hostactive ../lib_xua/src/core/user/hid ../lib_xua/src/core/user/audiohw