From 022a5cb01d22270cfd39022ae85af73c71f12a7e Mon Sep 17 00:00:00 2001
From: "Peter W. Draper" <p.w.draper@durham.ac.uk>
Date: Thu, 28 Jul 2022 17:47:06 +0100
Subject: [PATCH] Add some comments to stop header reordering when formatting

---
 argparse/argparse.c                      | 1 +
 src/black_holes_struct.h                 | 2 ++
 src/chemistry.h                          | 2 ++
 src/cooling/EAGLE/cooling_tables.c       | 1 +
 src/cooling/EAGLE/cooling_tables.h       | 2 ++
 src/cooling/QLA_EAGLE/cooling_tables.c   | 1 +
 src/cosmology.h                          | 2 ++
 src/engine_config.c                      | 1 +
 src/line_of_sight.h                      | 2 ++
 src/memswap.h                            | 1 +
 src/mesh_gravity_patch.c                 | 1 +
 src/neutrino/Default/neutrino_response.c | 2 ++
 src/sink_struct.h                        | 2 ++
 tests/testAdiabaticIndex.c               | 3 +++
 tests/testDistance.c                     | 3 +++
 tests/testErfc.c                         | 2 ++
 tests/testExp.c                          | 2 ++
 tests/testHashmap.c                      | 1 +
 tests/testHydroMPIrules.c                | 3 +++
 tests/testKernel.c                       | 3 +++
 tests/testKernelLongGrav.c               | 2 ++
 tests/testLog.c                          | 2 ++
 tests/testMaths.c                        | 3 +++
 tests/testRandom.c                       | 1 +
 tests/testRandomPoisson.c                | 1 +
 tests/testRandomSpacing.c                | 1 +
 tests/testSymmetry.c                     | 3 +++
 tests/testTimeline.c                     | 2 ++
 28 files changed, 52 insertions(+)

diff --git a/argparse/argparse.c b/argparse/argparse.c
index 8372f45bc6..483a8a8460 100644
--- a/argparse/argparse.c
+++ b/argparse/argparse.c
@@ -9,6 +9,7 @@
 
 #include <config.h>
 
+/* System includes */
 #include <assert.h>
 #include <errno.h>
 #include <stdio.h>
diff --git a/src/black_holes_struct.h b/src/black_holes_struct.h
index f6d06443a1..09027e83f7 100644
--- a/src/black_holes_struct.h
+++ b/src/black_holes_struct.h
@@ -26,6 +26,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes */
 #include "inline.h"
 
 /* Import the right black holes definition */
diff --git a/src/chemistry.h b/src/chemistry.h
index 6c93049e32..ba303b4d4d 100644
--- a/src/chemistry.h
+++ b/src/chemistry.h
@@ -26,6 +26,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes. */
 #include "chemistry_struct.h"
 
 /* Import the right chemistry definition */
diff --git a/src/cooling/EAGLE/cooling_tables.c b/src/cooling/EAGLE/cooling_tables.c
index 06cc2d91d7..0b32ce20d9 100644
--- a/src/cooling/EAGLE/cooling_tables.c
+++ b/src/cooling/EAGLE/cooling_tables.c
@@ -25,6 +25,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <hdf5.h>
 #include <math.h>
 #include <stdlib.h>
diff --git a/src/cooling/EAGLE/cooling_tables.h b/src/cooling/EAGLE/cooling_tables.h
index b8f41fba51..c492fa962d 100644
--- a/src/cooling/EAGLE/cooling_tables.h
+++ b/src/cooling/EAGLE/cooling_tables.h
@@ -26,6 +26,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes. */
 #include "cooling_struct.h"
 
 /*! Number of different bins along the redhsift axis of the tables */
diff --git a/src/cooling/QLA_EAGLE/cooling_tables.c b/src/cooling/QLA_EAGLE/cooling_tables.c
index 657b910e38..5ee735a0f2 100644
--- a/src/cooling/QLA_EAGLE/cooling_tables.c
+++ b/src/cooling/QLA_EAGLE/cooling_tables.c
@@ -25,6 +25,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <hdf5.h>
 #include <math.h>
 #include <stdlib.h>
diff --git a/src/cosmology.h b/src/cosmology.h
index ad141944ed..cb7e96bfcd 100644
--- a/src/cosmology.h
+++ b/src/cosmology.h
@@ -21,6 +21,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes. */
 #include "parser.h"
 #include "physical_constants.h"
 #include "timeline.h"
diff --git a/src/engine_config.c b/src/engine_config.c
index 5ecaa5341c..26df9d07fa 100644
--- a/src/engine_config.c
+++ b/src/engine_config.c
@@ -22,6 +22,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
diff --git a/src/line_of_sight.h b/src/line_of_sight.h
index 8c7966c464..158c0fce6c 100644
--- a/src/line_of_sight.h
+++ b/src/line_of_sight.h
@@ -23,6 +23,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes. */
 #include "engine.h"
 #include "io_properties.h"
 
diff --git a/src/memswap.h b/src/memswap.h
index 8a0404a930..12de6d0883 100644
--- a/src/memswap.h
+++ b/src/memswap.h
@@ -22,6 +22,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <stdint.h>
 
 #ifdef HAVE_IMMINTRIN_H
diff --git a/src/mesh_gravity_patch.c b/src/mesh_gravity_patch.c
index a0f3b97652..bce169f990 100644
--- a/src/mesh_gravity_patch.c
+++ b/src/mesh_gravity_patch.c
@@ -20,6 +20,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <math.h>
 
 /* This object's header. */
diff --git a/src/neutrino/Default/neutrino_response.c b/src/neutrino/Default/neutrino_response.c
index 26e3286e5e..4d841a633c 100644
--- a/src/neutrino/Default/neutrino_response.c
+++ b/src/neutrino/Default/neutrino_response.c
@@ -19,6 +19,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/* Local includes. */
 #include "parser.h"
 
 #ifdef HAVE_LIBGSL
diff --git a/src/sink_struct.h b/src/sink_struct.h
index d0c94cc612..00e6380298 100644
--- a/src/sink_struct.h
+++ b/src/sink_struct.h
@@ -26,6 +26,8 @@
 
 /* Config parameters. */
 #include <config.h>
+
+/*  Local includes. */
 #include "inline.h"
 
 /* Import the right black holes definition */
diff --git a/tests/testAdiabaticIndex.c b/tests/testAdiabaticIndex.c
index dd6e28d9e2..2255d11fea 100644
--- a/tests/testAdiabaticIndex.c
+++ b/tests/testAdiabaticIndex.c
@@ -17,8 +17,11 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 
+/* System includes. */
 #include <fenv.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/tests/testDistance.c b/tests/testDistance.c
index fcf16bf65d..91b2985a0a 100644
--- a/tests/testDistance.c
+++ b/tests/testDistance.c
@@ -17,8 +17,11 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 
+/* System includes. */
 #include <fenv.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/tests/testErfc.c b/tests/testErfc.c
index f4067988b7..548558eaa4 100644
--- a/tests/testErfc.c
+++ b/tests/testErfc.c
@@ -18,6 +18,8 @@
  ******************************************************************************/
 
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 
 /* Standard includes */
diff --git a/tests/testExp.c b/tests/testExp.c
index d4a3194a92..7362eff2c9 100644
--- a/tests/testExp.c
+++ b/tests/testExp.c
@@ -18,6 +18,8 @@
  ******************************************************************************/
 
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 
 /* Standard includes */
diff --git a/tests/testHashmap.c b/tests/testHashmap.c
index a7ebf5288c..4feff1e631 100644
--- a/tests/testHashmap.c
+++ b/tests/testHashmap.c
@@ -20,6 +20,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <fenv.h>
 
 /* Local headers. */
diff --git a/tests/testHydroMPIrules.c b/tests/testHydroMPIrules.c
index 4401cc8be8..799d86adee 100644
--- a/tests/testHydroMPIrules.c
+++ b/tests/testHydroMPIrules.c
@@ -17,8 +17,11 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 
+/* System includes. */
 #include <fenv.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/tests/testKernel.c b/tests/testKernel.c
index 6567b76b2d..3de191598d 100644
--- a/tests/testKernel.c
+++ b/tests/testKernel.c
@@ -18,10 +18,13 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "align.h"
 #include "kernel_hydro.h"
 #include "vector.h"
 
+/* System includes. */
 #include <fenv.h>
 #include <stdlib.h>
 #include <strings.h>
diff --git a/tests/testKernelLongGrav.c b/tests/testKernelLongGrav.c
index bea26bbf11..3b8c3d2711 100644
--- a/tests/testKernelLongGrav.c
+++ b/tests/testKernelLongGrav.c
@@ -18,6 +18,8 @@
  ******************************************************************************/
 
 #include <config.h>
+
+/* Local includes. */
 #include "exp10.h"
 #include "swift.h"
 
diff --git a/tests/testLog.c b/tests/testLog.c
index 5d434d256a..6dc1c12eb9 100644
--- a/tests/testLog.c
+++ b/tests/testLog.c
@@ -18,6 +18,8 @@
  ******************************************************************************/
 
 #include <config.h>
+
+/* Local includes. */
 #include "exp10.h"
 #include "log.h"
 #include "swift.h"
diff --git a/tests/testMaths.c b/tests/testMaths.c
index 717e632ac9..cc3432ec26 100644
--- a/tests/testMaths.c
+++ b/tests/testMaths.c
@@ -18,9 +18,12 @@
  ******************************************************************************/
 
 #include <config.h>
+
+/* Local includes. */
 #include "approx_math.h"
 #include "vector.h"
 
+/* System includes. */
 #include <math.h>
 #include <stdio.h>
 
diff --git a/tests/testRandom.c b/tests/testRandom.c
index b40d43f943..1cc7fb151a 100644
--- a/tests/testRandom.c
+++ b/tests/testRandom.c
@@ -21,6 +21,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <fenv.h>
 
 /* Local headers. */
diff --git a/tests/testRandomPoisson.c b/tests/testRandomPoisson.c
index d1547043b5..afd84304ef 100644
--- a/tests/testRandomPoisson.c
+++ b/tests/testRandomPoisson.c
@@ -20,6 +20,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <fenv.h>
 
 /* Local headers. */
diff --git a/tests/testRandomSpacing.c b/tests/testRandomSpacing.c
index a4766d971c..cb4dac9a60 100644
--- a/tests/testRandomSpacing.c
+++ b/tests/testRandomSpacing.c
@@ -20,6 +20,7 @@
 /* Config parameters. */
 #include <config.h>
 
+/* System includes. */
 #include <fenv.h>
 
 /* Local headers. */
diff --git a/tests/testSymmetry.c b/tests/testSymmetry.c
index 0f3fdf693c..a1fa8ed7bc 100644
--- a/tests/testSymmetry.c
+++ b/tests/testSymmetry.c
@@ -17,9 +17,12 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "swift.h"
 #include "timestep_limiter_iact.h"
 
+/* System includes. */
 #include <fenv.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/tests/testTimeline.c b/tests/testTimeline.c
index 97a5e5931f..51b8d2b51a 100644
--- a/tests/testTimeline.c
+++ b/tests/testTimeline.c
@@ -17,6 +17,8 @@
  *
  ******************************************************************************/
 #include <config.h>
+
+/* Local includes. */
 #include "timeline.h"
 #include "tools.h"
 
-- 
GitLab