From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1noz0R-0005ST-QI for mharc-grub-devel@gnu.org; Wed, 11 May 2022 22:56:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36202) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1noz0Q-0005QE-FV for grub-devel@gnu.org; Wed, 11 May 2022 22:56:46 -0400 Received: from mail-ua1-x92c.google.com ([2607:f8b0:4864:20::92c]:41554) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1noz0O-0008Fi-RZ for grub-devel@gnu.org; Wed, 11 May 2022 22:56:46 -0400 Received: by mail-ua1-x92c.google.com with SMTP id x5so1507102uap.8 for ; Wed, 11 May 2022 19:56:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=ONnxcXm17is2/EEK/ItU2kQ0qNgB+EflHYe7WQSJ6i0=; b=oPPwuZOMwekXhqzyQJV/ZXXfAksvSylpYxJeGKIMl4hmKeYqJ3x5cNXgDlydkljL2k JX13lI5HDUfgc4nXmly178wjO2Fk2HBAk0+uIlOBuVB1EgJWURmVdBYgqxqIbb2GnT6c jPfonV3oU/5uudtDxzMTbKBGGMmdSuN/1Byxaooi6y5w0yDn2hmdbbv13M42Lq6B92Rn fLIbIU8M/9vY73w8KZX1jPcE1QoaS39zO4P4Ofycbv7Cmb/c5c6+QV073NozU2CqUTTG Gfo68FNvtE32A1EikML0q3hVkjt5R10nbxcvJFnuU/tdQJS1UJWOoeLHyz/eO+3zKLR2 5FAg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=ONnxcXm17is2/EEK/ItU2kQ0qNgB+EflHYe7WQSJ6i0=; b=O/WxLvI9WTJDeowQ1N9em7/YXISlz3FNb+YgQemBRbi/ITF3KgFx2cn7eWxDPAY9D8 +sY97QSFg3+qYTqwsV6FYxfOdlOuIZ72iDBtOIleS8IborQQmzrFJN/s41hb24wTrECs vCprbltM6hWXKjS1WuseAufxNIP10YUk78dzgTiwEsrN3eMSwjPzBiHY7NgXB+NVF7xC H6TpwbUIwxQRTTrGh2VgmPhYfa0PCt2+N44mm7C5RtHXU0hqZ+cf6vT7ldN3pjBTjURa i+mMRSPKLIEz1wfI79S0z5YnY8/UQxBigb/624GL8TIcfWWvXagMG9UFwe3e4hozYqSa t3bA== X-Gm-Message-State: AOAM532IF4z0Yp4yAHDF0fdAUgrhJA+0sLmSDdGal9tdZC8lVNsWkd+X SAJtLyx52agfqdR91lz9QeJHsZ2V+m7GjvCu X-Google-Smtp-Source: ABdhPJx8oKxTK2RJ2FU1oamWiNFjvIZSrfiMY54CVSYIAGfXU3Qz4mDphYR8h3Dz0B2LvyvRbpB/5Q== X-Received: by 2002:ab0:2857:0:b0:362:819c:ea57 with SMTP id c23-20020ab02857000000b00362819cea57mr15236659uaq.33.1652324203464; Wed, 11 May 2022 19:56:43 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id m7-20020a05612210e700b0034e6f1fd05esm490769vko.40.2022.05.11.19.56.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 11 May 2022 19:56:42 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Glenn Washburn Subject: [PATCH 0/7] Various docs improvements Date: Wed, 11 May 2022 21:56:17 -0500 Message-Id: X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::92c; envelope-from=development@efficientek.com; helo=mail-ua1-x92c.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 12 May 2022 02:56:46 -0000 The first 4 patches need no explanation. The 5th patch creates a new section just for loader commands and moves loader commands to that section from the general commands section. Patch #6 adds an itemized list of currently under-documented loader commands to the text part of the loader command section. And patch #7 adds a new section for undocumented commands and contains an itemized list of undocumented commands (now minimally documented!) These two lists of undocumented commands was partially generated by grepping for command registration in the source and pulling out the registered command name and help string. The hope is that these two lists will make it easier for non-programmers (or anyone) to contribute to GRUB by choosing a command to flesh out. Also, I wanted this list so that I have a way to quickly see all the available commands to choose potentially interesting ones for use. So far I've found some commands that I didn't know existed. I don't particularly like how patch #6 renders to html, with the justification of the two itemized lists (one of the undocumented loader commands and the other the documented loader commands) being different. I'm open to suggestiong on how this might be improved. Glenn Glenn Washburn (7): docs: Fix spelling typo and remove unnecessary spaces docs: Make note that sendkey is only available on i386-pc docs: Make note of i386-pc specific usage of halt command docs: Markup loader commands with @command tag docs: Create command section for loader commands docs: Add under documented loader commands to beginning of loader section docs: Add section for general undocumented commands docs/grub-dev.texi | 10 +- docs/grub.texi | 376 +++++++++++++++++++++++++++++++-------------- 2 files changed, 269 insertions(+), 117 deletions(-) -- 2.34.1