Regex: +regex string lifetime comment

[jankratochvil]

Summary

Is the wording OK? The lifetime was found by Jonas Devlieghere.

[labath]

llvm/include/llvm/Support/Regex.h

48

I don't think you need the *lifetime* of that string -- you need the string itself. :) Just drop that word, and this will be fine.

[jankratochvil]

llvm/include/llvm/Support/Regex.h

48

The lifetime keyword was there to highlight the main point of that statement. But I agree it should be clear enough even without it.

llvm/include/llvm/Support/Regex.h

enum {
       /// By default, the POSIX extended regular expression (ERE) syntax is
       /// assumed. Pass this flag to turn on basic regular expressions (BRE)
       /// instead.
       BasicRegex=4
     };
 
     Regex();
     /// Compiles the given regular expression \p Regex.
+    ///
+    /// \param Regex - referenced string lifetime is no longer needed after this
+    /// constructor does finish.  Only its compiled form is kept stored.
     Regex(StringRef Regex, unsigned Flags = NoFlags);
     Regex(const Regex &) = delete;
     Regex &operator=(Regex regex) {
       std::swap(preg, regex.preg);
       std::swap(error, regex.error);
       return *this;
     }
     Regex(Regex &&regex);