Move generated message to details folder (#304)

* Move generated message to details folder

Signed-off-by: Nate Koenig <nate@openrobotics.org>

* more details

Signed-off-by: Nate Koenig <nate@openrobotics.org>

Signed-off-by: Nate Koenig <nate@openrobotics.org>
Co-authored-by: Nate Koenig <nate@openrobotics.org>

Author: nkoenig

CMakeLists.txt

@@ -144,7 +144,7 @@ configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials
 gz_create_docs(
   API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
   TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
-  AUTOGENERATED_DOC "${CMAKE_BINARY_DIR}/include/gz/msgs/"
+  AUTOGENERATED_DOC "${CMAKE_BINARY_DIR}/include/gz/msgs/details"
   TAGFILES
     "${GZ-MATH_DOXYGEN_TAGFILE} = ${GZ-MATH_API_URL}"
 )

src/CMakeLists.txt

@@ -71,8 +71,8 @@ function(gz_msgs_protoc)
   if(gz_msgs_protoc_GENERATE_CPP)
     # Full path to generated header (${PROJECT_BINARY_DIR}/include/gz/msgs/foo.pb.h)
     set(output_header "${gz_msgs_protoc_OUTPUT_CPP_DIR}${proto_package_dir}/${FIL_WE}.pb.h")
-    # Full path to generated detail header (${PROJECT_BINARY_DIR}/include/gz/msgs/detail/foo.pb.h)
-    set(output_detail_header "${gz_msgs_protoc_OUTPUT_CPP_DIR}${proto_package_dir}/detail/${FIL_WE}.pb.h")
+    # Full path to generated detail header (${PROJECT_BINARY_DIR}/include/gz/msgs/details/foo.pb.h)
+    set(output_detail_header "${gz_msgs_protoc_OUTPUT_CPP_DIR}${proto_package_dir}/details/${FIL_WE}.pb.h")
     # Full path to generated ignition header (${PROJECT_BINARY_DIR}/include/ignition/msgs/foo.pb.h)
     set(output_ign_header "${gz_msgs_protoc_OUTPUT_CPP_DIR}/ignition/msgs/${FIL_WE}.pb.h")
     # Full path to generated ignition header (${PROJECT_BINARY_DIR}/include/foo.pb.cc)
@@ -198,9 +198,9 @@ gz_install_includes(
   "${GZ_INCLUDE_INSTALL_DIR_POSTFIX}/gz/${GZ_DESIGNATION}"
   ${gen_headers})
 
-# Install gz/msgs/detail
+# Install gz/msgs/details
 gz_install_includes(
-  "${GZ_INCLUDE_INSTALL_DIR_POSTFIX}/gz/${IGN_DESIGNATION}/detail"
+  "${GZ_INCLUDE_INSTALL_DIR_POSTFIX}/gz/${IGN_DESIGNATION}/details"
   ${gen_detail_headers})
 
 # Install ignition/msgs

src/Generator.cc

@@ -96,7 +96,7 @@ bool Generator::Generate(const FileDescriptor *_file,
   // The renaming operation is handled via the outside python script
   //
   // gz/msgs/msg.pb.cc - stays in place
-  // gz/msgs/msg.pb.h -> gz/msgs/detail/msg.pb.h
+  // gz/msgs/msg.pb.h -> gz/msgs/details/msg.pb.h
   // gz/msgs/msg.gz.h (generated here) -> gz/msgs/msg.pb.h
   std::string identifier;
   std::string headerFilename;
@@ -114,7 +114,7 @@ bool Generator::Generate(const FileDescriptor *_file,
   }
   identifier += fileStem;
   headerFilename += fileStem + ".gz.h";
-  newHeaderFilename += "detail/" + fileStem + ".pb.h";
+  newHeaderFilename += "details/" + fileStem + ".pb.h";
   sourceFilename += fileStem + ".pb.cc";
 
   std::map<std::string, std::string> variables;

tools/gz_msgs_generate.py

@@ -73,14 +73,14 @@ def main(argv=sys.argv[1:]):
         print(f'Failed to execute protoc compiler: {e}')
         sys.exit(-1)
 
-    # Move original generated cpp to detail/
+    # Move original generated cpp to details/
     proto_file = os.path.splitext(os.path.relpath(args.input_path, args.proto_path))[0]
     detail_proto_file = proto_file.split(os.sep)
 
     detail_proto_dir = detail_proto_file[:-1]
-    detail_proto_dir.append('detail')
+    detail_proto_dir.append('details')
     detail_proto_dir = os.path.join(*detail_proto_dir)
-    detail_proto_file.insert(-1, 'detail')
+    detail_proto_file.insert(-1, 'details')
     detail_proto_file = os.path.join(*detail_proto_file)
 
     header = os.path.join(args.output_cpp_path, proto_file + ".pb.h")