[Docs][NewPM] Add note about required passes

[ychen]

Thank you for writing this down.

llvm/docs/WritingAnLLVMNewPMPass.rst

217

Personally, I may reorder the structure a little bit:

(definition) A pass that defines a static isRequired() method that returns true is a required pass.
< ... example ...>
(motivation) - meta passes (pass manager, adaptor pass etc) - user passes: AlwaysInlinerPass etc.
(behavior) override all other mechanisms that may skip a pass, like "optnone" etc.

[aeubanks]

rework documentation

[ychen]

LGTM

llvm/docs/WritingAnLLVMNewPMPass.rst

.. code-block:: llvm
 
   ; CHECK-NEXT: {{^}}bar{{$}}
   define void @bar() {
     ret void
   }
 
   $ ninja -C build check-llvm
   # runs our new test alongside all other llvm lit tests
+
+FAQs
+====
+
+Required passes
+---------------
+
+If the pass is a required pass, meaning it must run on the IR to produce
+semantically valid output, add a static ``isRequired()`` method that returns
+true to the pass class.
+
+.. code-block:: c++
+
+  class HelloWorldPass : public PassInfoMixin<HelloWorldPass> {
+  public:
+    PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
+
+    static bool isRequired() { return true; }
+  };
+
+This will make it run even in the presence of something that skips
+optimization passes, like the ``optnone`` function attribute.
+
+``AlwaysInlinerPass`` is an example of a required pass in-tree.
+
+For more info on how this works, see
+``PassInstrumentation::runBeforePass()``.