Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-8166

Check for comments related to the ticket being worked on

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Major - P3
    • Resolution: Fixed
    • None
    • WT10.0.1, 5.2.0
    • None
    • None
    • 2
    • Storage - Ra 2021-11-15

    Description

      Context:

      Sometimes we work on a ticket and we need a piece of code to be fixed in another ticket and we leave a comment that looks like this:

      FIXME-WT-XXX 

      Same when we disable a test and we need to reenable it later on.

      When one starts working on a ticket, they might not be aware of all the FIXMEs related to that ticket. It would be great to update s_all so it can pick it up.

      Suggested solution:

      One solution would be using the git branch name given the following syntax:

      wt-xxx-<user_defined_description> 

      We could grep matching FIXME comments with a script as simple as this one:

      #! /bin/sh
       
      ticket=$(git rev-parse --abbrev-ref HEAD | cut -f1,2 -d'-')
      if grep -rni "FIXME-$ticket" ../; then
          echo "Please fix the remaining FIXME comments related to $ticket"
          exit 1
      fi
       
      exit 0 

      Unfortunately, if one does not use this syntax for their branch name, the script would not work in this case. Alternative solutions are welcome.

      Attachments

        Activity

          People

            etienne.petrel@mongodb.com Etienne Petrel
            etienne.petrel@mongodb.com Etienne Petrel
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: