From 3af4cfc52d7d72ebd93d277a7b46d3526f8f59d2 Mon Sep 17 00:00:00 2001 From: Stefan Karlsson Date: Wed, 29 Jan 2025 08:36:23 +0000 Subject: [PATCH] 8348180: Remove mention of include of precompiled.hpp from the HotSpot Style Guide Reviewed-by: dholmes, eosterlund --- doc/hotspot-style.html | 8 ++++---- doc/hotspot-style.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/hotspot-style.html b/doc/hotspot-style.html index 0305bfeca03..9f26fc66362 100644 --- a/doc/hotspot-style.html +++ b/doc/hotspot-style.html @@ -217,10 +217,10 @@ file as the first include line. Declarations needed by other files should be put in the .hpp file, and not in the .inline.hpp file. This rule exists to resolve problems with circular dependencies between .inline.hpp files.

-

  • All .cpp files include precompiled.hpp as the first include -line.

    • -

  • precompiled.hpp is just a build time optimization, so don't rely -on it to resolve include problems.

    • +

  • Some build configurations use precompiled headers to speed up the +build times. The precompiled headers are included in the precompiled.hpp +file. Note that precompiled.hpp is just a build time optimization, so +don't rely on it to resolve include problems.

  • Keep the include lines alphabetically sorted.

  • Put conditional inclusions (#if ...) at the end of the include list.

    • diff --git a/doc/hotspot-style.md b/doc/hotspot-style.md index f5e59648cb2..01506629817 100644 --- a/doc/hotspot-style.md +++ b/doc/hotspot-style.md @@ -150,10 +150,10 @@ the first include line. Declarations needed by other files should be put in the .hpp file, and not in the .inline.hpp file. This rule exists to resolve problems with circular dependencies between .inline.hpp files. -* All .cpp files include precompiled.hpp as the first include line. - -* precompiled.hpp is just a build time optimization, so don't rely on -it to resolve include problems. +* Some build configurations use precompiled headers to speed up the +build times. The precompiled headers are included in the precompiled.hpp +file. Note that precompiled.hpp is just a build time optimization, so +don't rely on it to resolve include problems. * Keep the include lines alphabetically sorted.