From dbfadc5a7e5bd3163b49878994063cd6d869fe6a Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Mon, 24 Mar 2025 21:47:40 +0800
Subject: Refactor

---
 global.go | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'global.go')

diff --git a/global.go b/global.go
index 39bbe4f..72057b5 100644
--- a/global.go
+++ b/global.go
@@ -3,11 +3,16 @@
 
 package main
 
+// global is a struct that holds global information that the HTML template may
+// wish to access.
 var global = struct {
+	// Most of these fields should be filled in by flag parsing.
 	NeedBits        uint
 	NeedBitsReverse uint
 	SourceURL       string
 	Version         string
 }{
+	// The version should be replaced by the init function in version.go,
+	// if version.go is properly generated by the Makefile.
 	Version: "(no version)",
 }
-- 
cgit v1.2.3