From c0507e7f8ea8ef506d5df26cee59c8237dbb1010 Mon Sep 17 00:00:00 2001 From: Cyrus Yip <60951091+CyrusYip@users.noreply.github.com> Date: Tue, 7 Dec 2021 00:37:58 +0800 Subject: [PATCH] chore(readme): improve format of FAQ --- README.md | 92 +++++++++++++++++++++++++++---------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index c42edcd6..99abacd3 100644 --- a/README.md +++ b/README.md @@ -102,73 +102,73 @@ pacman -S --needed git base-devel yay ## Frequently Asked Questions -- Yay does not display colored output. How do I fix it? +- **Yay does not display colored output. How do I fix it?** -Make sure you have the `Color` option in your `/etc/pacman.conf` -(see issue [#123](https://github.com/Jguer/yay/issues/123)). + Make sure you have the `Color` option in your `/etc/pacman.conf` + (see issue [#123](https://github.com/Jguer/yay/issues/123)). -- Yay is not prompting to skip packages during system upgrade. +- **Yay is not prompting to skip packages during system upgrade.** -The default behavior was changed after -[v8.918](https://github.com/Jguer/yay/releases/tag/v8.918) -(see [3bdb534](https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc) -and issue [#554](https://github.com/Jguer/yay/issues/554)). -To restore the package-skip behavior use `--combinedupgrade` (make -it permanent by appending `--save`). Note: skipping packages will leave your -system in a -[partially-upgraded state](https://wiki.archlinux.org/index.php/System_maintenance#Partial_upgrades_are_unsupported). + The default behavior was changed after + [v8.918](https://github.com/Jguer/yay/releases/tag/v8.918) + (see [3bdb534](https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc) + and issue [#554](https://github.com/Jguer/yay/issues/554)). + To restore the package-skip behavior use `--combinedupgrade` (make + it permanent by appending `--save`). Note: skipping packages will leave your + system in a + [partially-upgraded state](https://wiki.archlinux.org/index.php/System_maintenance#Partial_upgrades_are_unsupported). -- Sometimes diffs are printed to the terminal, and other times they are paged via less. How do I fix this? +- **Sometimes diffs are printed to the terminal, and other times they are paged via less. How do I fix this?** -Yay uses `git diff` to display diffs, which by default tells less not to -page if the output can fit into one terminal length. This behavior can be -overridden by exporting your own flags (`export LESS=SRX`). + Yay uses `git diff` to display diffs, which by default tells less not to + page if the output can fit into one terminal length. This behavior can be + overridden by exporting your own flags (`export LESS=SRX`). -- Yay is not asking me to edit PKGBUILDS, and I don't like the diff menu! What can I do? +- **Yay is not asking me to edit PKGBUILDS, and I don't like the diff menu! What can I do?** -`yay --editmenu --nodiffmenu --save` + `yay --editmenu --nodiffmenu --save` -- How can I tell Yay to act only on AUR packages, or only on repo packages? +- **How can I tell Yay to act only on AUR packages, or only on repo packages?** -`yay -{OPERATION} --aur` -`yay -{OPERATION} --repo` + `yay -{OPERATION} --aur` + `yay -{OPERATION} --repo` -- An `Out Of Date AUR Packages` message is displayed. Why doesn't Yay update them? +- **An `Out Of Date AUR Packages` message is displayed. Why doesn't Yay update them?** -This message does not mean that updated AUR packages are available. It means -the packages have been flagged out of date on the AUR, but -their maintainers have not yet updated the `PKGBUILD`s -(see [outdated AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Foo_in_the_AUR_is_outdated.3B_what_should_I_do.3F)). + This message does not mean that updated AUR packages are available. It means + the packages have been flagged out of date on the AUR, but + their maintainers have not yet updated the `PKGBUILD`s + (see [outdated AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Foo_in_the_AUR_is_outdated.3B_what_should_I_do.3F)). -- Yay doesn't install dependencies added to a PKGBUILD during installation. +- **Yay doesn't install dependencies added to a PKGBUILD during installation.** -Yay resolves all dependencies ahead of time. You are free to edit the -PKGBUILD in any way, but any problems you cause are your own and should not be -reported unless they can be reproduced with the original PKGBUILD. + Yay resolves all dependencies ahead of time. You are free to edit the + PKGBUILD in any way, but any problems you cause are your own and should not be + reported unless they can be reproduced with the original PKGBUILD. -- I know my `-git` package has updates but yay doesn't offer to update it +- **I know my `-git` package has updates but yay doesn't offer to update it** -Yay uses an hash cache for development packages. Normally it is updated at the end of the package install with the message `Found git repo`. -If you transition between aur helpers and did not install the devel package using yay at some point, it is possible it never got added to the cache. `yay -Y --gendb` will fix the current version of every devel package and start checking from there. + Yay uses an hash cache for development packages. Normally it is updated at the end of the package install with the message `Found git repo`. + If you transition between aur helpers and did not install the devel package using yay at some point, it is possible it never got added to the cache. `yay -Y --gendb` will fix the current version of every devel package and start checking from there. -- I want to help out! +- **I want to help out!** -Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information. + Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information. -- What settings do you use? +- **What settings do you use?** -```sh -yay -Y --devel --combinedupgrade --batchinstall --save -``` + ```sh + yay -Y --devel --combinedupgrade --batchinstall --save + ``` -Pacman conf options: + Pacman conf options: -```conf -UseSyslog -Color -CheckSpace -VerbosePkgLists -``` + ```conf + UseSyslog + Color + CheckSpace + VerbosePkgLists + ``` ## Support