Don't use the .so extension on test assets

[babeltrace.git] / tests / debuginfo-data / README.md

diff --git a/tests/debuginfo-data/README.md b/tests/debuginfo-data/README.md
index 88e773116c19fabb469851932fbe01de15525726..db131bc47811c24df0fa1fd0bbc58c5eb43cfe14 100644 (file)
--- a/tests/debuginfo-data/README.md
+++ b/tests/debuginfo-data/README.md
@@ -8,13 +8,17 @@ files used to generate them.
 
 The generated files are:
 
-* `libhello.so` (ELF and DWARF)
-* `libhello_elf.so` (ELF only)
-* `libhello_build_id.so` (ELF with separate DWARF via build ID)
-* `libhello_debug_link.so` (ELF with separate DWARF via debug link)
-* `libhello_debug_link.so.debug` (DWARF for debug link)
+* `libhello_so` (ELF and DWARF)
+* `libhello_elf_so` (ELF only)
+* `libhello_build_id_so` (ELF with separate DWARF via build ID)
+* `libhello_debug_link_so` (ELF with separate DWARF via debug link)
+* `libhello_debug_link_so.debug` (DWARF for debug link)
 * `.build-id/cd/d98cdd87f7fe64c13b6daad553987eafd40cbb.debug` (DWARF for build ID)
 
+We use a suffix of "_so" instead of ".so" since some distributions
+build systems will consider ".so" files as artifacts from a previous
+build that were "left-over" and will remove them prior to the build.
+
 All files are generated from the four (4) following source files:
 
 * libhello.c
@@ -30,20 +34,20 @@ To regenerate them, you can use follow these steps:
 ## ELF and DWARF
 
     $ gcc -g -fPIC -c -I. tp.c libhello.c
-    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello.so -o libhello.so tp.o libhello.o
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello.so -o libhello_so tp.o libhello.o
 
 ## ELF only
 
     $ gcc -fPIC -c -I. tp.c libhello.c
-    $ gcc -shared -llttng-ust -ldl -Wl,-soname,libhello_elf.so -o libhello_elf.so tp.o libhello.o
+    $ gcc -shared -llttng-ust -ldl -Wl,-soname,libhello_elf.so -o libhello_elf_so tp.o libhello.o
 
 ## ELF and DWARF with Build ID
 
     $ gcc -g -fPIC -c -I. tp.c libhello.c
-    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_build_id.so -Wl,--build-id=sha1 -o libhello_build_id.so tp.o libhello.o
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_build_id.so -Wl,--build-id=sha1 -o libhello_build_id_so tp.o libhello.o
     $ mkdir -p .build-id/cd/
-    $ objcopy --only-keep-debug libhello_build_id.so .build-id/cd/d98cdd87f7fe64c13b6daad553987eafd40cbb.debug
-    $ strip -g libhello_build_id.so
+    $ objcopy --only-keep-debug libhello_build_id_so .build-id/cd/d98cdd87f7fe64c13b6daad553987eafd40cbb.debug
+    $ strip -g libhello_build_id_so
 
 The build ID might not be the same once the executable is regenerated
 on your system, so adjust the values in the directory and file names
@@ -53,8 +57,8 @@ https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
 ##  ELF and DWARF with Debug Link
 
     $ gcc -g -fPIC -c -I. tp.c libhello.c
-    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_debug_link.so -o libhello_debug_link.so tp.o libhello.o
+    $ gcc -shared -g -llttng-ust -ldl -Wl,-soname,libhello_debug_link.so -o libhello_debug_link_so tp.o libhello.o
 
-    $ objcopy --only-keep-debug libhello_debug_link.so libhello_debug_link.so.debug
-    $ strip -g libhello_debug_link.so
-    $ objcopy --add-gnu-debuglink=libhello_debug_link.so.debug libhello_debug_link.so
+    $ objcopy --only-keep-debug libhello_debug_link_so libhello_debug_link_so.debug
+    $ strip -g libhello_debug_link_so
+    $ objcopy --add-gnu-debuglink=libhello_debug_link_so.debug libhello_debug_link_so