From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1mRg5Z-0002zf-5P for mharc-grub-devel@gnu.org; Sat, 18 Sep 2021 15:33:29 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:37398) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mRg5X-0002yb-6D for grub-devel@gnu.org; Sat, 18 Sep 2021 15:33:27 -0400 Received: from mail-il1-x135.google.com ([2607:f8b0:4864:20::135]:40644) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mRg5V-0006qA-3y for grub-devel@gnu.org; Sat, 18 Sep 2021 15:33:26 -0400 Received: by mail-il1-x135.google.com with SMTP id a20so14005978ilq.7 for ; Sat, 18 Sep 2021 12:33:24 -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=kYtrz8TChKrbXR0N5lNv6ls8xY4/vI457LF+02HjK/I=; b=SxNvwJms/jpIoT5uHrhObaFksKosGJ0s3zynzYWYov7iHMSys5W+poenPumg65GePK ypvuHLsnXG7UhCfx+4dUdArhbolHX7NrRTlXFUB+3YLsBLAOzGzitEEUcchBIn3XujsM MulidvDEsjAEwbJwgih1bmCU09Flm6XoxiDcUJlErM/JF+SToLOHcDSM3D4SzeUPW/Uc 1xZt/0LYcQ27imyvXIvtERvGidMhdJCJd8XQ67hFYnbvGVfSrr5tvVZMDkgZPwm7axva gsYPyUGcoCzSp4OgxgyEn9q8ZStwQh+nOS3ngdko7Y4u6qh3SkgwxuK9a5fgdmFFUP3U hkTg== 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=kYtrz8TChKrbXR0N5lNv6ls8xY4/vI457LF+02HjK/I=; b=V7GhaCrytIRYZhe77VHNTFSGVfwEjCLICNQncwbAFALuUDzssuAyLu7EuK+AhFbJcH tN0m7Zd+HThNNXRlRHgFsZ2OuLaOnL5AnOY3h8muaXOACTaM+09cMH+zUAgdqMNx3fcS VYpGgH3J4N/0yKyX+0cQRdYUBOt5LZn1caTBbFx6jrfB7NhRZEdt9rlM0W9XDgfT8ej9 MuvQ5qX/rcp5s0y7Gmnn41KIcsGg+LkaBwzuPp7G3pJI7J2nxtjqXyLshRfAEcR4VCEJ 0exEKtSw+/8MQS3sNPKcWmWn0e05pzYIpItXji7ELrrkl/7RL7K+f16w/wKbSxUeLVrh mG0Q== X-Gm-Message-State: AOAM5323jB2JxexBld663LigLWfLPyPUJFIkU/obWLFx1sy1f+7F7c9O gK9wzexUGC5vt6Qy/NQAzeyg0Lx7pQ59Lg== X-Google-Smtp-Source: ABdhPJw9viysAV1Y6RGwZm+LOzAJnRnnveWUYYIlEzK+YXKOMbw5UNkBWh8ws4h9rsftY89PIGiZ3w== X-Received: by 2002:a05:6e02:110f:: with SMTP id u15mr12468754ilk.6.1631993603700; Sat, 18 Sep 2021 12:33:23 -0700 (PDT) Received: from localhost.localdomain ([2806:103e:1d:2421:145:9729:b384:b701]) by smtp.gmail.com with ESMTPSA id a15sm5876281ila.34.2021.09.18.12.33.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 18 Sep 2021 12:33:23 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org Cc: Glenn Washburn , Daniel Kiper Subject: [PATCH] docs: Improve search documentation, by adding short options and section on hints Date: Sat, 18 Sep 2021 19:33:05 +0000 Message-Id: <20210918193305.1613138-1-development@efficientek.com> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::135; envelope-from=development@efficientek.com; helo=mail-il1-x135.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 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 18 Sep 2021 19:33:27 -0000 Signed-off-by: Glenn Washburn --- docs/grub.texi | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index 0be500387..8baf99ad1 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -4999,16 +4999,25 @@ Search devices by file (@option{-f}, @option{--file}), filesystem label (@option{-l}, @option{--label}), or filesystem UUID (@option{-u}, @option{--fs-uuid}). -If the @option{--set} option is used, the first device found is set as the -value of environment variable @var{var}. The default variable is +If the (@option{-s}, @option{--set}) option is used, the first device found is +set as the value of environment variable @var{var}. The default variable is @samp{root}. -The @option{--no-floppy} option prevents searching floppy devices, which can -be slow. +The (@option{-n}, @option{--no-floppy}) option prevents searching floppy +devices, which can be slow. The @samp{search.file}, @samp{search.fs_label}, and @samp{search.fs_uuid} commands are aliases for @samp{search --file}, @samp{search --label}, and @samp{search --fs-uuid} respectively. + +Also hints as to which device may be the most likely to contain the item +searched for may be given via the (@option{-h}, @option{--hint}) option with a +device name as an argument. If the argument ends with a comma, then partitions +on the device are also searched. Furthermore, platform specific hints may be +given via the options @option{--hint-ieee1275}, @option{--hint-bios}, +@option{--hint-baremetal}, @option{--hint-efi}, and @option{--hint-arc}. When +specified, these options take an argument and operate like @option{--hint}, but +only on the specified platform. @end deffn -- 2.32.0