From 331158da03624e96000e02610f9bae358a34b810 Mon Sep 17 00:00:00 2001 From: "Kelvin M. Klann" Date: Thu, 23 Mar 2023 17:48:00 -0300 Subject: docs: line-wrap some long lines --- .github/ISSUE_TEMPLATE/bug_report.md | 9 ++++++--- .github/pull_request_template.md | 6 ++++-- CONTRIBUTING.md | 7 ++++--- README | 27 +++++++++++++++++---------- README.md | 25 +++++++++++++++++-------- 5 files changed, 48 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 53066013d..fc74640d4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -22,7 +22,8 @@ _Describe the bug_ _Steps to reproduce the behavior_ -1. Run in bash `LC_ALL=C firejail PROGRAM` (`LC_ALL=C` to get a consistent output in English that can be understood by everybody) +1. Run in bash `LC_ALL=C firejail PROGRAM` (`LC_ALL=C` to get a consistent + output in English that can be understood by everybody) 2. Click on '....' 3. Scroll down to '....' 4. See error `ERROR` @@ -37,7 +38,8 @@ _What actually happened_ ### Behavior without a profile -_What changed calling `LC_ALL=C firejail --noprofile /path/to/program` in a terminal?_ +_What changed calling `LC_ALL=C firejail --noprofile /path/to/program` in a +terminal?_ ### Additional context @@ -47,7 +49,8 @@ _Any other detail that may help to understand/debug the problem_ - Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux") - Firejail version (`firejail --version`). -- If you use a development version of firejail, also the commit from which it was compiled (`git rev-parse HEAD`). +- If you use a development version of firejail, also the commit from which it + was compiled (`git rev-parse HEAD`). ### Checklist diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index faa2a4108..ecc5be304 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,8 @@ -If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR. +If your PR isn't about profiles or you have no idea how to do one of these, +skip the following and go ahead with this PR. -If you submit a PR for new profiles or changing profiles, please do the following: +If you submit a PR for new profiles or changing profiles, please do the +following: - The ordering of options follow the rules described in [etc/templates/profile.template](../blob/master/etc/templates/profile.template) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9cdfbc0f..ebc4d3a20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,8 @@ Welcome to firejail, and thank you for your interest in contributing! ## Opening an issue -We welcome issues, whether to ask a question, provide information, request a new profile or -feature, or to report a suspected bug or problem. +We welcome issues, whether to ask a question, provide information, request a +new profile or feature, or to report a suspected bug or problem. If you want to request a program profile that we don't already have, please add a comment in our dedicated issue: @@ -62,4 +62,5 @@ If you add a new command, here's the checklist: ## Editing the wiki -You are highly encouraged to add your own tips and tricks to the [wiki](https://github.com/netblue30/firejail/wiki). +You are highly encouraged to add your own tips and tricks to the +[wiki](https://github.com/netblue30/firejail/wiki). diff --git a/README b/README index fb8737c31..9833e078e 100644 --- a/README +++ b/README @@ -59,7 +59,8 @@ Committers: - rusty-snake (https://github.com/rusty-snake) - smitsohu (https://github.com/smitsohu) - SkewedZeppelin (https://github.com/SkewedZeppelin) -- startx2017 (https://github.com/startx2017) - LTS and *bugfixes branches maintainer) +- startx2017 (https://github.com/startx2017) - LTS and *bugfixes branches + maintainer) - Topi Miettinen (https://github.com/topimiettinen) - veloute (https://github.com/veloute) - Vincent43 (https://github.com/Vincent43) @@ -317,7 +318,8 @@ curiosityseeker (https://github.com/curiosityseeker - new) - updated keypassxc profile - added syscalls.sh, which determine the necessary syscalls for a program - fixed conky profile - - thunderbird.profile: harden and enable the rules necessary to make Firefox open links + - thunderbird.profile: harden and enable the rules necessary to make + Firefox open links da2x (https://github.com/da2x) - matched RPM license tag Daan Bakker (https://github.com/dbakker) @@ -362,7 +364,8 @@ Disconnect3d (https://github.com/disconnect3d) dm9pZCAq (https://github.com/dm9pZCAq) - fix for compilation under musl dmfreemon (https://github.com/dmfreemon) - - add sandbox name or name of private directory to the window title when xpra is used + - add sandbox name or name of private directory to the window title + when xpra is used - handle malloc() failures; use gnu_basename() instead of basenaem() Dmitriy Chestnykh (https://github.com/chestnykh) - add ability to disable user profiles at compile time @@ -1034,7 +1037,8 @@ soredake (https://github.com/soredake) - add localtime to private-etc to make qtox show correct time - fixes for the keepassxc 2.2.5 version SkewedZeppelin (https://github.com/SkewedZeppelin) - - added Bless, Gnome 2048, Gnome Calculator, Gnome Contacts, JD-GUI, Lollypop, MultiMC5 profiles + - added Bless, Gnome 2048, Gnome Calculator, Gnome Contacts, JD-GUI, + Lollypop, MultiMC5 profiles - added PDFSam, Pithos, and Xonotic profiles - disabled Go, Rust, and OpenSSL in disable-devel.conf - added dino profile @@ -1052,7 +1056,8 @@ SkewedZeppelin (https://github.com/SkewedZeppelin) - added IntelliJ IDEA and Android Studio profiles - added arm profile - lots of profile improvements/tightening - - added apktool, baobab, dex2jar, gitg, hashcat, obs, picard, remmina, sdat2img, + - added apktool, baobab, dex2jar, gitg, hashcat, obs, picard, remmina, + sdat2img, soundconverter, sqlitebrowser, and truecraft profiles - added gnome-twitch profile - Unified all 341 profiles @@ -1089,10 +1094,12 @@ SYN-cook (https://github.com/SYN-cook) - gnome-calculator changes startx2017 (https://github.com/startx2017) - syscall list update - - updated default seccomp filters - added bpf, clock_settime, personality, process_vm_writev, query_module, - settimeofday, stime, umount, userfaultfd, ustat, vm86, and vm86old + - updated default seccomp filters - added bpf, clock_settime, + personality, process_vm_writev, query_module, settimeofday, stime, + umount, userfaultfd, ustat, vm86, and vm86old - enable/disable join support in /etc/firejail/firejail.config - - firecfg fix: create ~/.local/share/applications directory if it doesn't exist + - firecfg fix: create ~/.local/share/applications directory if it + doesn't exist - firejail.config cleanup - --quiet fixes - bugfixes branches maintainer @@ -1254,8 +1261,8 @@ Zack Weinberg (https://github.com/zackw) - wait_for_other function rewrite - Xvfb X11 server support - Xvfb and Xephyr profiles, modified Xpra profile - - support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes when started - with firejail --x11 + - support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes + when started with firejail --x11 - support for xpra-extra-params in firejail.config zupatisc (https://github.com/zupatisc) - patch-util fix diff --git a/README.md b/README.md index ab8cca261..05dd2a52f 100644 --- a/README.md +++ b/README.md @@ -74,11 +74,14 @@ See [SECURITY.md](SECURITY.md). ### Debian -Debian stable (bullseye): We recommend to use the [backports](https://packages.debian.org/bullseye-backports/firejail) package. +Debian stable (bullseye): We recommend to use the +[backports](https://packages.debian.org/bullseye-backports/firejail) package. ### Ubuntu -For Ubuntu 18.04+ and derivatives (such as Linux Mint), users are **strongly advised** to use the [PPA](https://launchpad.net/~deki/+archive/ubuntu/firejail). +For Ubuntu 18.04+ and derivatives (such as Linux Mint), users are **strongly +advised** to use the +[PPA](https://launchpad.net/~deki/+archive/ubuntu/firejail). How to add and install from the PPA: @@ -88,10 +91,12 @@ sudo apt-get update sudo apt-get install firejail firejail-profiles ``` -Reason: The firejail package for Ubuntu 20.04 has been left vulnerable to CVE-2021-26910 for months after a patch for it was posted on Launchpad: +Reason: The firejail package for Ubuntu 20.04 has been left vulnerable to +CVE-2021-26910 for months after a patch for it was posted on Launchpad: * [CVE-2021-26910](https://github.com/advisories/GHSA-2q4h-h5jp-942w) -* [firejail version in Ubuntu 20.04 LTS is vulnerable to CVE-2021-26910](https://bugs.launchpad.net/ubuntu/+source/firejail/+bug/1916767) +* [firejail version in Ubuntu 20.04 LTS is vulnerable to + CVE-2021-26910](https://bugs.launchpad.net/ubuntu/+source/firejail/+bug/1916767) See also : @@ -102,12 +107,15 @@ See also : > the Ubuntu Security team for the life of an Ubuntu release, while binary > packages in universe and multiverse are supported by the Ubuntu community. -Additionally, the PPA version is likely to be more recent and to contain more profile fixes. +Additionally, the PPA version is likely to be more recent and to contain more +profile fixes. See the following discussions for details: -* [Should I keep using the version of firejail available in my distro repos?](https://github.com/netblue30/firejail/discussions/4666) -* [How to install the latest version on Ubuntu and derivatives](https://github.com/netblue30/firejail/discussions/4663) +* [Should I keep using the version of firejail available in my distro + repos?](https://github.com/netblue30/firejail/discussions/4666) +* [How to install the latest version on Ubuntu and + derivatives](https://github.com/netblue30/firejail/discussions/4663) ### Other @@ -149,7 +157,8 @@ sudo apt-get install git build-essential libapparmor-dev pkg-config gawk For `--selinux` option, add libselinux1-dev (libselinux-devel for Fedora). -Detailed information on using firejail from git is available on the [wiki](https://github.com/netblue30/firejail/wiki/Using-firejail-from-git). +Detailed information on using firejail from git is available on the +[wiki](https://github.com/netblue30/firejail/wiki/Using-firejail-from-git). ## Running the sandbox -- cgit v1.2.3-54-g00ecf