Skip to content

Commit

Permalink
Revise document of gosh -V
Browse files Browse the repository at this point in the history
and add doc on GAUCHE_VERSION_INFO_EXCLUSION.
  • Loading branch information
shirok committed Oct 12, 2024
1 parent 6e91267 commit 2dcda1d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 16 deletions.
5 changes: 3 additions & 2 deletions doc/concepts.texi
Original file line number Diff line number Diff line change
Expand Up @@ -332,14 +332,15 @@ Gaucheはプログラムを読み込む時に、トークン@code{#!fold-case}
@c EN
@item Use @code{-fcase-fold} command-line argument
Alternatively, you can give a command-line argument @code{-fcase-fold}
to the @code{gosh} command (@pxref{Invoking Gosh}).
to the @code{gosh} command (@pxref{Gosh command-line options}).
In this mode, the reader folds uppercase characters in symbols to lowercase
ones. If a symbol name contains uppercase characters, it is written
out using |-escape (@pxref{Symbols}).
@c JP
@item @code{-fcase-fold}コマンドライン引数を使う
また、@code{gosh}インタプリタの起動時に@code{-fcase-fold}コマンドライン引数を
与えると、Gaucheは大文字小文字を区別しないモードで動作します (@ref{Invoking Gosh}参照)。
与えると、Gaucheは大文字小文字を区別しないモードで動作します
(@ref{Gosh command-line options}参照)。
このモードでは、リーダはシンボルの読み込みの際に大文字を小文字に変換します。
大文字を含んでいるシンボルに関しては、`|' 文字でエスケープされて書き出されます
(@ref{Symbols}参照)。
Expand Down
13 changes: 11 additions & 2 deletions doc/corelib.texi
Original file line number Diff line number Diff line change
Expand Up @@ -10410,14 +10410,14 @@ used with another string. A string cursor also becomes invalid when
the associated string is modified. Accessing an invalid cursor does
not always fail though. Running @code{gosh} with @code{-fsafe-string-cursors}
could help catch these issues, with some performance overhead.
@xref{Invoking Gosh}.
@xref{Gosh command-line options}.
@c JP
文字列カーソルは特定の文字列と結びついていて、それ以外の文字列に対して使うのは無効です。
また、元の文字列が変更されると文字列カーソルは無効になります。
ただ、無効になったカーソルを使っても必ずしもエラーになるとは限りません。
@code{gosh}を@code{-fsafe-string-cursors}オプションつきで起動すると、
性能が落ちますがその種のエラーを検出することができます。
詳しくは@ref{Invoking Gosh}を参照してください。
詳しくは@ref{Gosh command-line options}を参照してください。
@c COMMON

@c EN
Expand Down Expand Up @@ -29459,6 +29459,15 @@ The information is the same as what displayed with @code{gosh -V}.
様々なランタイムの情報をalistで返します。
@code{gosh -V}で表示される情報と同じです。
@c COMMON

@c EN
The result is affected by the value of the environemnt variable
@code{GAUCHE_VERSION_INFO_EXCLUSION}. @xref{Environment variables},
for details.
@c JP
結果は環境変数@code{GAUCHE_VERSION_INFO_EXCLUSION}に影響を受けます。
詳しくは@ref{Environment variables}を参照してください。
@c COMMON
@end defun

@defun sys-available-processors
Expand Down
57 changes: 45 additions & 12 deletions doc/program.texi
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,14 @@ Scheme program and exit.
@c COMMON
@end deftp

@c EN
@subheading Command-line options
@c JP
@subheading コマンドラインオプション
@c COMMON
@menu
* Gosh command-line options::
* Environment variables::
@end menu

@node Gosh command-line options, Environment variables, Invoking Gosh, Invoking Gosh
@subsection Command-line options
@c NODE コマンドラインオプション

@c EN
The following command line options are recognized by @code{gosh}.
Expand Down Expand Up @@ -112,9 +115,18 @@ Makes @code{gosh} not to load the default initialization file.

@deftp {Command Option} -V
@c EN
Prints the @code{gosh} version and exits.
Prints the @code{gosh} version, and various configuration information
(SRFI-176). See @code{version-alist} for the details of configuration
parameters @pxref{Environment inquiry}.
You can control what info to be shown by the environment variable
@code{GAUCHE_VERSION_INFO_EXCLUSION} (@pxref{Environment variables}).
section below.
@c JP
@code{gosh}のバージョンを表示して終了します。
@code{gosh}のバージョンおよび様々なコンフィグレーション情報を表示します
(SRFI-176)。コンフィグレーション情報については@code{version-alist}を見てください
(@ref{Environment inquiry})。
どういった情報を表示するかは、環境変数@code{GAUCHE_VERSION_INFO_EXCLUSION}で
カスタマイズできます。@ref{Environment variables}参照。
@c COMMON
@end deftp

Expand Down Expand Up @@ -451,11 +463,9 @@ of appearance. For example, adding a load path by -I affects the
与えません。
@c COMMON

@c EN
@subheading Environment variables
@c JP
@subheading 環境変数
@c COMMON
@node Environment variables, , Gosh command-line options, Invoking Gosh
@subsection Environment variables
@c NODE 環境変数

@c EN
The following environment variables are recognized:
Expand Down Expand Up @@ -699,6 +709,29 @@ Useful for diagnosis of unexpected errors.
@c COMMON
@end deftp

@deftp {Environment variable} GAUCHE_VERSION_INFO_EXCLSION
@c EN
The value must be a comma-separated keys in @code{version-alist}
(@pxref{Environment inquiry}).
The keys listed here are excluded from the output of @code{gosh -V}.
For example, the following setting omits @code{scheme.path} and
@code{build.configure} from output of @code{gosh -V}. Those values
may contain username and/or project names, and there may be cases
when you don't want make them to be public accidentally, by attaching
output of @code{gosh -V} to a bug report or something.
@c JP
値は@code{version-alist}に現れるキーをコンマ区切りで並べたものです
(@ref{Environment inquiry}参照)。ここに挙げられたキーは、@code{gosh -V}
の出力から除外されます。例えば次の設定は、@code{gosh -V}の出力に
@code{scheme.path}と@code{build.configure}を含めません。
これらの値はユーザ名やプロジェクト名を含んでいる場合がありますが、
バグレポート等に@code{gosh -V}の結果を含める時に、
それらをうっかり公開してしまわないようにしたい、という場合などに便利です。
@c COMMON
@example
GAUCHE_VERSION_INFO_EXCLUSION=scheme.path,build.configure
@end example
@end deftp

@deftp {Environment variable} TMP
@deftpx {Environment variable} TMPDIR
Expand Down
3 changes: 3 additions & 0 deletions src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ void usage(int errorp)
" GAUCHE_TEST_REPORT_ERROR\n"
" When set, a stack trace is printed when an error is raised during\n"
" running the test code in ``gauche.test'' framework.\n"
" GAUCHE_VERSION_INFO_EXCLUSION\n"
" The value must be a comma-separated keys in version-alist.\n"
" The keys listed here are excluded from the output of gosh -V.\n"
#if defined(GAUCHE_WINDOWS)
" GAUCHE_WINDOWS_CONSOLE_RAW\n"
" (Windows only) On Windows (MinGW), gosh in interactive mode wraps\n"
Expand Down

0 comments on commit 2dcda1d

Please sign in to comment.