[IR] Keep a double break between function decls and defs

[rnk]

Summary

This behavior appears to have changed unintentionally in
b0e979724f2679e4e6f5b824144ea89289bd6d56.

Instead of printing the leading newline in printFunction, print it when
printing a module. This ensures that OS << *Func starts printing
immediately on the current line, but whole modules are printed nicely.

[MaskRay]

Thanks. b0e979724f2679e4e6f5b824144ea89289bd6d56 intended to make newpm and oldpm -print-after-all output similar. I did not realize llvm-dis output is also affected.

Keep a double break between function decls and defs

This patch also inserts an empty line between two declarations or two definitions.

(It actually adds a newline before printing any declaration or definition.)

[merge_guards_bot]

Unit tests: pass. 62246 tests passed, 0 failed and 816 were skipped.

clang-tidy: pass.

clang-format: pass.

Build artifacts: diff.json, clang-tidy.txt, clang-format.patch, CMakeCache.txt, console-log.txt, test-results.xml

Pre-merge checks is in beta. Report issue. Please join beta or enable it for your project.

[rnk]

In D73505#1843138, @MaskRay wrote:

Keep a double break between function decls and defs

This patch also inserts an empty line between two declarations or two definitions.

(It actually adds a newline before printing any declaration or definition.)

I meant to indicate that a double break should appear between both kinds of function, so I will just say "functions".

@hans, I will merge this to the release/10.x branch, let me know if that needs more review or should be undone.

[hans]

@hans, I will merge this to the release/10.x branch, let me know if that needs more review or should be undone.

Sounds good to me, go ahead.

llvm/lib/IR/AsmWriter.cpp

void AssemblyWriter::printModule(const Module *M) {
   if (!M->ifunc_empty()) Out << "\n";
   for (const GlobalIFunc &GI : M->ifuncs())
     printIndirectSymbol(&GI);
 
   // Output global use-lists.
   printUseLists(nullptr);
 
   // Output all of the functions.
-  for (const Function &F : *M)
+  for (const Function &F : *M) {
+    Out << '\n';
     printFunction(&F);
+  }
   assert(UseListOrders.empty() && "All use-lists should have been consumed");
 
   // Output all attribute groups.
   if (!Machine.as_empty()) {
     Out << '\n';
     writeAllAttributeGroups();
   }
 

llvm/test/Feature/undefined.ll

 ; RUN: llvm-as < %s | llvm-dis > %t1.ll
 ; RUN: llvm-as %t1.ll -o - | llvm-dis > %t2.ll
 ; RUN: diff %t1.ll %t2.ll
+; RUN: FileCheck %s < %t1.ll
 
 @X = global i32 undef           ; <i32*> [#uses=0]
 
 declare i32 @atoi(i8*)
 
 define i32 @test() {
         ret i32 undef
 }
 
 define i32 @test2() {
         %X = add i32 undef, 1           ; <i32> [#uses=1]
         ret i32 %X
 }
 
+
+; Check that there is a newline between functions.
+
+; CHECK: @X = global
+; CHECK-EMPTY:
+; CHECK: declare i32 @atoi(i8*)
+; CHECK-EMPTY:
+; CHECK: define i32 @test() {
+; CHECK: {{^[}]}}
+; CHECK-EMPTY:
+; CHECK: define i32 @test2() {
+; CHECK: {{^[}]}}