Tcl Source Code

Ticket Change Details
Login
Overview

Artifact ID: 1112faa25a3817f5b90a641c6864d63e00bfa40d71dce1b4e576c66de182fd95
Ticket: ef7042075cfd6c029435e6c37ff161190d98c80d
tcl::build-info not documented
User & Date: dkf 2025-06-26 08:16:24
Changes

  1. icomment:
    Good idea to document this. I approve! Review of the candidate manpage follows:
    
    > I'm wondering whether the `SYNOPSIS` is too busy.
    > 
    > Perhaps it would be better as just this:
    > ```
    > \fB::tcl::build-info\fR ?\fIfield\fR?
    > ```
    > 
    > That says you the command has one optional argument, _field_, and that's basically all that it needs to say.
    > 
    > I guess the `DESCRIPTION` should then be:
    > ```
    > This command provides a way to retrieve information about how Tcl was built.
    > Without a \fIfield\fR, the command returns the Tcl patchlevel, followed
    > by the '\fB+\fR'-sign, followed by the fossil commit-id followed by a list of
    > dot-separated tags. If a \fIfield\fR is given, this command extracts that
    > field as described below. For official Tcl releases, the \fIfield\fRs are:
    > ```
    > 
    > The remaining parts of the manual page look fine. Perhaps we ought to add more references into the `SEE ALSO` section? (`platform(n)` and `tcl_platform(n)`/`tclvars(n)` would be my candidates.)
    >
    > If you don't change the `SYNOPSIS` as suggested, at least remove the `?` from the first line of it; the subsequent lines make it unnecessary in that case and it's technically ambiguous according to our simple command syntax rules.
    
    Do as you will with the review, but I hope it helps.
    
  2. login: "dkf"
  3. mimetype: "text/x-markdown"