Merge pull request #6283 from IntersectMBO/jutaro/docu_generation2

Improved Documentation UX

Author: mgmeier

cardano-node/src/Cardano/Node/Tracing/Documentation.hs

@@ -7,7 +7,9 @@
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE StandaloneDeriving #-}
+{-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeOperators #-}
+
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 module Cardano.Node.Tracing.Documentation
@@ -18,7 +20,7 @@ module Cardano.Node.Tracing.Documentation
   , docTracersFirstPhase
   ) where
 
-import           Cardano.Node.Tracing.NodeStartupInfo () -- MetaTrace NodeVersionTrace
+import           Cardano.Git.Rev (gitRev)
 import           Cardano.Logging as Logging
 import           Cardano.Logging.Resources
 import           Cardano.Logging.Resources.Types ()
@@ -29,6 +31,7 @@ import           Cardano.Node.TraceConstraints
 import           Cardano.Node.Tracing.DefaultTraceConfig (defaultCardanoConfig)
 import           Cardano.Node.Tracing.Formatting ()
 import           Cardano.Node.Tracing.NodeInfo ()
+import           Cardano.Node.Tracing.NodeStartupInfo ()
 import qualified Cardano.Node.Tracing.StateRep as SR
 import           Cardano.Node.Tracing.Tracers.BlockReplayProgress
 import           Cardano.Node.Tracing.Tracers.ChainDB
@@ -111,13 +114,18 @@ import           Control.Exception (SomeException)
 import           Control.Monad (forM_)
 import           Data.Aeson.Types (ToJSON)
 import           Data.Proxy (Proxy (..))
+import           Data.Text (pack)
 import qualified Data.Text.IO as T
+import           Data.Time (getZonedTime)
+import           Data.Version (showVersion)
 import           GHC.Generics (Generic)
 import qualified Network.Mux as Mux
 import qualified Network.Socket as Socket
 import qualified Options.Applicative as Opt
 import           System.IO
 
+import           Paths_cardano_node (version)
+
 
 data TraceDocumentationCmd
   = TraceDocumentationCmd
@@ -832,6 +840,7 @@ docTracersFirstPhase condConfigFileName = do
             <> dtAcceptPolicyTrDoc
 -- Internal tracer
             <> internalTrDoc
+
     pure (bl,trConfig)
 
 docTracersSecondPhase ::
@@ -841,8 +850,15 @@ docTracersSecondPhase ::
   -> DocTracer
   -> IO ()
 docTracersSecondPhase outputFileName mbMetricsHelpFilename trConfig bl = do
-    docuResultsToText bl trConfig
-      >>= doWrite outputFileName
+    let text = docuResultsToText bl trConfig
+    time <- getZonedTime
+    let stamp = "Generated at "
+             <> pack (show time)
+             <> ", git commit hash "
+             <> $(gitRev)
+             <> ", node version "
+             <> pack (showVersion version) <> "\n"
+    doWrite outputFileName (text <> stamp)
     forM_ mbMetricsHelpFilename $ \f ->
        doWrite f (docuResultsToMetricsHelptext bl)
   where