add a short comment to explain why AnnotationException are ignored

symfony · fancyweb · Dec 16, 2016 · Dec 20, 2016 · Dec 27, 2016 · Dec 20, 2016
commit 7cf56c43fcbe860ac51a118af99ffd1baed59471
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AnnotationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AnnotationsCacheWarmer.php
@@ -77,7 +77,16 @@ public function warmUp($cacheDir)
                } catch (\ReflectionException $e) {
                    // ignore failing reflection
                } catch (AnnotationException $e) {
-
+                    /*
+                     * Ignore any AnnotationException to not break the cache warming process if an Annotation is badly
+                     * configured or could not be found / read / etc.
+                     *
+                     * In particular cases, an Annotation in your code can be used and defined only for a specific
+                     * environment but is always added to the annotations.map file by some Symfony default behaviors,
+                     * and you always end up with a not found Annotation.
+                     *
+                     * cf https://github.com/symfony/symfony/pull/20959 for a longer explanation.
+                     */
                }
            }
        } finally {
-Original file line number
+Diff line change
@@ -77,7 +77,16 @@ public function warmUp($cacheDir)
                     } catch (\ReflectionException $e) {
                         // ignore failing reflection
                     } catch (AnnotationException $e) {
+                        /*
+                         * Ignore any AnnotationException to not break the cache warming process if an Annotation is badly
+                         * configured or could not be found / read / etc.
+                         *
+                         * In particular cases, an Annotation in your code can be used and defined only for a specific
+                         * environment but is always added to the annotations.map file by some Symfony default behaviors,
+                         * and you always end up with a not found Annotation.
+                         *
+                         * cf https://github.com/symfony/symfony/pull/20959 for a longer explanation.
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            nicolas-grekas
  

      

      

      


        Dec 26, 2016


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      this should be removed, we don't add links to github: the git history (git blame) should have everything instead (which it has)
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
+                         */
                     }
                 }
             } finally {
-          Expand Down