Merge pull request #86 from night1rider/GH-Issue-85

Readme update and layer.conf cleanup

README.md

@@ -17,7 +17,9 @@ This layer currently provides recipes for the following wolfSSL products:
 
 These recipes have been tested using these versions of yocto:
 
+- Scarthgap     (v5.0)
 - Nanbield      (v4.3)
+- Langdale      (v4.1)
 - Kirkstone     (v4.0)
 - Hardknott     (v3.3)
 - Gatesgarth    (v3.2)
@@ -69,58 +71,39 @@ After installing your build's Yocto/OpenEmbedded components:
 
 
     2.  If you want to run `bitbake wolf*` on a particular recipe then it needs 
-        uncommented in `local.conf` located in `meta-wolfssl/conf/`. 
+        to be added to the IMAGE_INSTALL.
-
+        This can be done by adding the following line to `local.conf` located in 
-        As an example if wolfssh is desired the following needs to occur:
+        `path/to/poky/build/conf`. 
-        From "meta-wolfssl" directory
+        - For Dunfell and newer versions of Yocto:
         ```
-        $ vim conf/layer.conf
+        IMAGE_INSTALL:append = " wolfssl wolfssh wolfmqtt wolftpm "
         ```
-        Then look for the text:
-        ```
-        # Uncomment if building wolfssh with wolfssl
-        #BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfssh/*.bb \
-        #            ${LAYERDIR}/recipes-wolfssl/wolfssh/*.bbappend"
-        ```
-        Then uncomment by removing the #, it should look like this afterwards
-        ```
-        # Uncomment if building wolfssh with wolfssl
-        BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfssh/*.bb \
-               ${LAYERDIR}/recipes-wolfssl/wolfssh/*.bbappend"
-        ```
-
-        This needs to be done in order to preform a bitbake operation on any of the 
-        recipes. 
         
-        You should make sure to comment out recipes you don't want to use to 
+        - For versions of Yocto older than Dunfell:
-        avoid uneeded --enable-options in your wolfSSL version. wolfSSL is 
-        uncommented by default.
 
-        Once the recipes that need to be compiled are uncommented,
+        ```
-        you can build the individual product/test recipes to make sure they 
+        IMAGE_INSTALL_append = " wolfssl wolfssh wolfmqtt wolftpm "
-        compile successfully:
+        ```
 
         ```
         $ bitbake wolfssl
         $ bitbake wolfssh
         $ bitbake wolfmqtt
         $ bitbake wolftpm
-        $ bitbake wolfclu
+        $ bitbake wolfclu - This command would result in an error
         ```
 
+
 3.  Edit your build's local.conf file to install the recipes you would like
     to include (ie: wolfssl, wolfssh, wolfmqtt, wolftpm) 
     
     - For Dunfell and newer versions of Yocto
-    IMAGE_INSTALL:append line:
 
     ```
     IMAGE_INSTALL:append = " wolfssl wolfssh wolfmqtt wolftpm wolfclu "
     ```
     
     - For versions of Yocto older than Dunfell
-    IMAGE_INSTALL_append line:
-
     ```
     IMAGE_INSTALL_append = " wolfssl wolfssh wolfmqtt wolftpm wolfclu "
     ```

conf/layer.conf

@@ -10,21 +10,11 @@ BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfssl/*.bb ${LAYERDIR}/recipes-wolfssl/wolfssl/*.bbappend', \
                                  '', d)}"
 
-#Comment out if you don't want to use wolfclu 
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfclu/*.bb \
-#            ${LAYERDIR}/recipes-wolfssl/wolfclu/*.bbappend"
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfclu', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfclu/*.bb ${LAYERDIR}/recipes-wolfssl/wolfclu/*.bbappend', \
                                  '', d)}"
 
-# Uncomment if wanting to use example test/benchmark for wolfcrypt                                                
-#BBFILES += "${LAYERDIR}/recipes-examples/wolfcrypt/wolfcryptbenchmark/*.bb \
-#             ${LAYERDIR}/recipes-examples/wolfcrypt/wolfcryptbenchmark/*.bbappend" 
-#BBFILES += "${LAYERDIR}/recipes-examples/wolfcrypt/wolfcrypttest/*.bb \
-#             ${LAYERDIR}/recipes-examples/wolfcrypt/wolfcrypttest/*.bbappend" 
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfcryptbenchmark', \
                                  '${LAYERDIR}/recipes-examples/wolfcrypt/wolfcryptbenchmark/*.bb ${LAYERDIR}/recipes-examples/wolfcrypt/wolfcryptbenchmark/*.bbappend', \
@@ -35,62 +25,36 @@ BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  '${LAYERDIR}/recipes-examples/wolfcrypt/wolfcrypttest/*.bb ${LAYERDIR}/recipes-examples/wolfcrypt/wolfcrypttest/*.bbappend' , \
                                  '', d)}"
 
-
-# Uncomment if building wolfssh with wolfssl
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfssh/*.bb \
-#            ${LAYERDIR}/recipes-wolfssl/wolfssh/*.bbappend"
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfssh', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfssh/*.bb ${LAYERDIR}/recipes-wolfssl/wolfssh/*.bbappend', \
                                  '', d)}"
 
-
-# Uncomment if building wolfmqtt with wolfssl
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfmqtt/*.bb \
-#            ${LAYERDIR}/recipes-wolfssl/wolfmqtt/*.bbappend"
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfmqtt', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfmqtt/*.bb ${LAYERDIR}/recipes-wolfssl/wolfmqtt/*.bbappend', \
                                  '', d)}"
 
-
-# Uncomment if building wolftpm with wolfssl
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolftpm/*.bb \
-#           ${LAYERDIR}/recipes-wolfssl/wolftpm/*.bbappend"
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolftpm', \
                                  '${LAYERDIR}/recipes-wolfssl/wolftpm/*.bb ${LAYERDIR}/recipes-wolfssl/wolftpm/*.bbappend', \
                                  '', d)}"
 
-# Uncomment if building wolfssl-py
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfssl-py/*.bb \
-#            ${LAYERDIR}/recipes-wolfssl/wolfssl-py/*.bbappend"
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfssl-py', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfssl-py/*.bb ${LAYERDIR}/recipes-wolfssl/wolfssl-py/*.bbappend', \
                                  '', d)}"
 
-# Uncomment if building wolfcrypt-py
-#BBFILES += "${LAYERDIR}/recipes-wolfssl/wolfcrypt-py/*.bb \
-#            ${LAYERDIR}/recipes-wolfssl/wolfcrypt-py/*.bbappend"
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfcrypt-py', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfcrypt-py/*.bb ${LAYERDIR}/recipes-wolfssl/wolfcrypt-py/*.bbappend', \
                                  '', d)}"
 
-
-# Uncomment if wanting to use example tests for wolfssl-py/wolfcrypt-py                                                 
-#BBFILES += "${LAYERDIR}/recipes-examples/wolfssl-py/wolf-py-tests/*.bb \
-#            ${LAYERDIR}/recipes-examples/wolfssl-py/wolf-py-tests/*.bbappend" 
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolf-py-tests', \
                                  '${LAYERDIR}/recipes-examples/wolfssl-py/wolf-py-tests/*.bb ${LAYERDIR}/recipes-examples/wolfssl-py/wolf-py-tests/*.bbappend', \
                                  '', d)}"
 
-
 BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  'wolfprovider', \
                                  '${LAYERDIR}/recipes-wolfssl/wolfprovider/*.bb ${LAYERDIR}/recipes-wolfssl/wolfprovider/*.bbappend', \
@@ -111,8 +75,6 @@ BBFILES += "${@bb.utils.contains('IMAGE_INSTALL', \
                                  '${LAYERDIR}/recipes-examples/wolfengine/wolfenginetest/*.bb ${LAYERDIR}/recipes-examples/wolfengine/wolfenginetest/*.bbappend', \
                                  '', d)}"
 
-
-
 # Uncomment if building bind with wolfSSL.
 #BBFILES += "${LAYERDIR}/recipes-connectivity/bind/*.bbappend"