Bash: What does “masking return values” mean?












5















shellcheck generated the following warning



SC2155: Declare and assign separately to avoid masking return
values


For this line of code



local key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


What does "masking return values" mean, and how does it pertain to the aforementioned warning?










share|improve this question









New contributor




Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.

























    5















    shellcheck generated the following warning



    SC2155: Declare and assign separately to avoid masking return
    values


    For this line of code



    local key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


    What does "masking return values" mean, and how does it pertain to the aforementioned warning?










    share|improve this question









    New contributor




    Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.























      5












      5








      5








      shellcheck generated the following warning



      SC2155: Declare and assign separately to avoid masking return
      values


      For this line of code



      local key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


      What does "masking return values" mean, and how does it pertain to the aforementioned warning?










      share|improve this question









      New contributor




      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.












      shellcheck generated the following warning



      SC2155: Declare and assign separately to avoid masking return
      values


      For this line of code



      local key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


      What does "masking return values" mean, and how does it pertain to the aforementioned warning?







      bash shell-script shellcheck






      share|improve this question









      New contributor




      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question









      New contributor




      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question








      edited yesterday







      Inquisitor













      New contributor




      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked yesterday









      InquisitorInquisitor

      304




      304




      New contributor




      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      Inquisitor is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






















          1 Answer
          1






          active

          oldest

          votes


















          6














          When you declare a variable as either local or exported that in itself is a command that will return success or not.



          $ var=$(false)
          $ echo $?
          1
          $ export var=$(false)
          $ echo $?
          0


          So if you wanted to act on the return value of your command (echo "$current_line" | mawk '/.+=.+/ {print $1 }'), you would be unable to since it's going to exit with 0 as long as the local declaration succeeds (which is almost always will).



          In order to avoid this it suggests declaring separately and then assigning:



          local key_value
          key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


          This is a shellcheck rule I frequently ignore and IMO is safe to ignore as long as you know you aren't trying to act on the return value of that variable declaration.



          You can ignore it by adding the following to the top of your script (Below the hashbang of course):



          # shellcheck disable=SC2155





          share|improve this answer



















          • 1





            Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

            – Charles Duffy
            yesterday













          Your Answer








          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "106"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });






          Inquisitor is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f506352%2fbash-what-does-masking-return-values-mean%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          1 Answer
          1






          active

          oldest

          votes








          1 Answer
          1






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes









          6














          When you declare a variable as either local or exported that in itself is a command that will return success or not.



          $ var=$(false)
          $ echo $?
          1
          $ export var=$(false)
          $ echo $?
          0


          So if you wanted to act on the return value of your command (echo "$current_line" | mawk '/.+=.+/ {print $1 }'), you would be unable to since it's going to exit with 0 as long as the local declaration succeeds (which is almost always will).



          In order to avoid this it suggests declaring separately and then assigning:



          local key_value
          key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


          This is a shellcheck rule I frequently ignore and IMO is safe to ignore as long as you know you aren't trying to act on the return value of that variable declaration.



          You can ignore it by adding the following to the top of your script (Below the hashbang of course):



          # shellcheck disable=SC2155





          share|improve this answer



















          • 1





            Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

            – Charles Duffy
            yesterday


















          6














          When you declare a variable as either local or exported that in itself is a command that will return success or not.



          $ var=$(false)
          $ echo $?
          1
          $ export var=$(false)
          $ echo $?
          0


          So if you wanted to act on the return value of your command (echo "$current_line" | mawk '/.+=.+/ {print $1 }'), you would be unable to since it's going to exit with 0 as long as the local declaration succeeds (which is almost always will).



          In order to avoid this it suggests declaring separately and then assigning:



          local key_value
          key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


          This is a shellcheck rule I frequently ignore and IMO is safe to ignore as long as you know you aren't trying to act on the return value of that variable declaration.



          You can ignore it by adding the following to the top of your script (Below the hashbang of course):



          # shellcheck disable=SC2155





          share|improve this answer



















          • 1





            Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

            – Charles Duffy
            yesterday
















          6












          6








          6







          When you declare a variable as either local or exported that in itself is a command that will return success or not.



          $ var=$(false)
          $ echo $?
          1
          $ export var=$(false)
          $ echo $?
          0


          So if you wanted to act on the return value of your command (echo "$current_line" | mawk '/.+=.+/ {print $1 }'), you would be unable to since it's going to exit with 0 as long as the local declaration succeeds (which is almost always will).



          In order to avoid this it suggests declaring separately and then assigning:



          local key_value
          key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


          This is a shellcheck rule I frequently ignore and IMO is safe to ignore as long as you know you aren't trying to act on the return value of that variable declaration.



          You can ignore it by adding the following to the top of your script (Below the hashbang of course):



          # shellcheck disable=SC2155





          share|improve this answer













          When you declare a variable as either local or exported that in itself is a command that will return success or not.



          $ var=$(false)
          $ echo $?
          1
          $ export var=$(false)
          $ echo $?
          0


          So if you wanted to act on the return value of your command (echo "$current_line" | mawk '/.+=.+/ {print $1 }'), you would be unable to since it's going to exit with 0 as long as the local declaration succeeds (which is almost always will).



          In order to avoid this it suggests declaring separately and then assigning:



          local key_value
          key_value=$(echo "$current_line" | mawk '/.+=.+/ {print $1 }')


          This is a shellcheck rule I frequently ignore and IMO is safe to ignore as long as you know you aren't trying to act on the return value of that variable declaration.



          You can ignore it by adding the following to the top of your script (Below the hashbang of course):



          # shellcheck disable=SC2155






          share|improve this answer












          share|improve this answer



          share|improve this answer










          answered yesterday









          Jesse_bJesse_b

          13.5k23371




          13.5k23371








          • 1





            Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

            – Charles Duffy
            yesterday
















          • 1





            Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

            – Charles Duffy
            yesterday










          1




          1





          Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

          – Charles Duffy
          yesterday







          Folks determining whether their code is "trying to act on the return value" should keep in mind that having set -e or an ERR trap fire is also an action (though I don't recommend their use regardless).

          – Charles Duffy
          yesterday












          Inquisitor is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          Inquisitor is a new contributor. Be nice, and check out our Code of Conduct.













          Inquisitor is a new contributor. Be nice, and check out our Code of Conduct.












          Inquisitor is a new contributor. Be nice, and check out our Code of Conduct.
















          Thanks for contributing an answer to Unix & Linux Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f506352%2fbash-what-does-masking-return-values-mean%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Plaza Victoria

          In PowerPoint, is there a keyboard shortcut for bulleted / numbered list?

          How to put 3 figures in Latex with 2 figures side by side and 1 below these side by side images but in...