Commit graph

40 commits

Author SHA1 Message Date
Kelvin M. Klann
811e0fb0a0 docs: update supported version to 0.9.80
Relates to #7016.
2026-03-15 03:06:35 -03:00
Kelvin M. Klann
e02d8f0058 docs: update supported version to 0.9.78
Relates to #6965.
2026-01-03 00:52:56 -03:00
Kelvin M. Klann
e92d25656a docs: github: specify the supported version directly
Bug reports were opened by multiple users with the item checked even
when using version 0.9.74 or earlier.

So be explicit and write "0.9.76 or later" in the item, which should
help clarify that earlier versions are not supported.

This amends commit be065d130 ("docs: clarify that only latest and dev
versions are supported (#6965)", 2025-11-15).
2025-12-15 09:59:24 -03:00
Kelvin M. Klann
491b46cfa3
docs: always use full path to program in examples (#6963)
And add it to the bug report template checklist.

To avoid potential issues due to firejail-in-firejail.

Commands used to search and replace:

    perl -pi -e '
      s/(firejail)( .*)? (blobby|dig|firefox|galculator|gedit|gimp|handbrake|icecat|iceweasel|mc|openbox|transmission|vlc|warzone2100|wget|xed|xterm)/$1$2 \/usr\/bin\/$3/;
    ' README.md src/firejail/usage.c src/man/*.in
    perl -pi -e 's/^\s*(firefox \\?-)/\/usr\/bin\/$1/' \
      src/man/firejail.1.in

Note: Some parts were edited manually.

Note: Most tests still use the program basename.

Relates to #2877.
2025-11-16 08:39:05 +00:00
Kelvin M. Klann
be065d1301
docs: clarify that only latest and dev versions are supported (#6965)
To avoid wasting time due to (for example):

* Bugs that were already fixed
* Old versions with different/missing verbosity in the output
* Behavior that only affects (or differs in) old versions
* Copying and pasting profile lines which contain commands that are
  unsupported in old versions (or that depend on other changes to
  profiles in the current version)

This is a follow-up to #6964.
2025-11-15 04:53:08 +00:00
Kelvin M. Klann
c902890cd1
docs: github: clarify how to attach logs (#6858)
Link to the GitHub docs for attaching a file[1].

This should be more straightforward in most cases and would avoid
polluting the user profile with gists unnecessarily (which might get in
the way of using/managing other gists), especially over time when
dealing with many projects/issues/comments.

Keep the gist as a fallback option just in case the file attachment
feature randomly gets broken for an extended period of time, as the
GitHub web UI overall keeps getting slower and jankier over time.

Note: It seems that in both cases (attachment/gist), the file size limit
in the web UI is 25MB[2].

Relates to #5398.

Misc: This was noticed on #5611.

[1] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files
[2] https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-size-limits
2025-08-16 11:42:58 +00:00
Kelvin M. Klann
1d4bbd1c51
docs: github: add program name/version to bug_report.md (#6607)
See also commit 9bccccfa7 ("docs: github: streamline environment in
issue templates (#6471)", 2024-09-13).
2025-01-15 10:22:04 +00:00
Kelvin M. Klann
508394fbd8 docs: github: improve kernel headers item in build_issue.md
Relates to #6423 #6471.
2024-09-13 05:16:11 -03:00
Kelvin M. Klann
9bccccfa77
docs: github: streamline environment in issue templates (#6471)
Changes:

* Sync bug_report.md with build_issue.md (reword items and add Linux
  kernel item)
* Add a colon to the end of every item (to clarify where to add the
  information)
* Add the Environment section to feature_request.md

The last item is intended as a basic sanity check, as users using an
outdated version of firejail may request something that was already
implemented (for example, see #6461).

Relates to #4515 #6423.
2024-09-13 08:16:09 +00:00
Kelvin M. Klann
7299f832fb
docs: add build_issue.md issue template (#6423)
Based on `.github/ISSUE_TEMPLATE/bug_report.md`.

Relates to #6417.
2024-08-07 16:24:09 +00:00
glitsj16
386ee003d2
docs: bug_report.md: use absolute path in 'steps to reproduce' (#6382)
We still see lots of issue reports where the user runs `firejail foo`
and ends up running foo's sandbox twice (due to firecfg's symlink
precedence). Try to improve the situation by explicitly using absolute
paths in the 'steps to reproduce' section.
2024-06-14 08:59:38 +00:00
Kelvin M. Klann
331158da03 docs: line-wrap some long lines 2023-03-26 13:51:25 -03:00
Kelvin M. Klann
823ff0a014 docs: fix headings and yaml frontmatter 2023-03-24 11:06:36 -03:00
Kelvin M. Klann
452d70cc77 Trim trailing whitespace
Commands used to search and replace:

    $ git grep -Ilz '[[:blank:]]$' |
      xargs -0 -I '{}' sh -c "printf '%s\n' \"\$(sed -E \
        's/[[:blank:]]+$//' '{}')\" >'{}'"

This fixes all of the "trailing whitespace" errors raised by git:

    $ git diff --check 4b825dc642cb6eb9a060e54bf8d69288fbee4904..HEAD |
      grep '^[^+]' | cut -f 3 -d : | LC_ALL=C sort | uniq -c
         72  space before tab in indent.
          4  trailing whitespace.
2023-02-19 20:57:24 -03:00
rusty-snake
06bb505ec5
Add gist note to bug_report.md (#5398)
We had some comments saying that the output exceeds the
allowed length of a github comment (65534 characters IIRC).

This commit adds a comment to instruct users to create a secret gist in that case.
2022-10-03 16:57:05 +00:00
Kelvin M. Klann
20727361b2 bug_report.md: link to markdown formatting help
As suggested by @rusty-snake.
2021-09-20 08:25:07 -03:00
Kelvin M. Klann
b39ef34e0a bug_report.md: add checked item example
It is not uncommon for people to use other characters to try to mark an
item as checked (which usually screws up the html output), so be sure to
include an example with "[x]".
2021-09-20 08:21:50 -03:00
Kelvin M. Klann
2b2df66047 bug_report.md: use LC_ALL where appropriate 2021-09-19 08:18:17 -03:00
Kelvin M. Klann
f9620708e0 bug_report.md: use LC_ALL instead of LANG
This overrides all `LC_*` variables (and LANG) rather than just LANG.

From Section 8.2, Internationalization Variables of POSIX.1-2017[1]:

> LANG
>     This variable shall determine the locale category for native
>     language, local customs, and coded character set in the absence of
>     the LC_ALL and other LC_* (LC_COLLATE, LC_CTYPE, LC_MESSAGES,
>     LC_MONETARY, LC_NUMERIC, LC_TIME) environment variables.  This can
>     be used by applications to determine the language to use for error
>     messages and instructions, collating sequences, date formats, and
>     so on.
>
> LC_ALL
>     This variable shall determine the values for all locale
>     categories.  The value of the LC_ALL environment variable has
>     precedence over any of the other environment variables starting
>     with LC_ (LC_COLLATE, LC_CTYPE, LC_MESSAGES, LC_MONETARY,
>     LC_NUMERIC, LC_TIME) and the LANG environment variable.

[1] https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html
2021-09-19 08:16:40 -03:00
Kelvin M. Klann
b3212edeed bug_report.md: clarify message
Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com>
2021-09-17 14:38:06 +02:00
Kelvin M. Klann
1b1009c408 bug_report.md: improve grammar
Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com>
2021-09-17 14:37:58 +02:00
Kelvin M. Klann
a138a6545b bug_report.md: remove extraneous newline 2021-09-16 09:12:34 -03:00
rusty-snake
7b3cd31cfe Rework issue templates 2021-09-07 18:10:34 +02:00
Kelvin M. Klann
26d6744737 bug_report.md: add log section
Currently, the log portion seems to be part of the Checklist section.
2021-08-25 15:04:25 -03:00
Kelvin M. Klann
dc3859f345 bug_report.md: format the details section
And put the code block inside of an HTML paragraph, so that it's not
just free floating after the `<summary>`.
2021-08-25 15:04:25 -03:00
Kelvin M. Klann
06317bcdd2 bug_report.md: trim leading spaces on list items 2021-08-25 15:04:25 -03:00
Kelvin M. Klann
7b69b3ddcd bug_report.md: turn section titles into headers
This properly separates the document into sections and makes the titles
stand out more.  It is also more consistent with what is generated by
GitHub issue forms (YAML).

See also the following discussion:
https://github.com/netblue30/firejail/discussions/4468
2021-08-25 15:04:23 -03:00
Kelvin M. Klann
df766272bb bug_report.md: add missing blank lines
Isolate each section title and each list from other elements, to make
them more visually distinguishable.  This should also make it easier to
find and edit only the parts that are meant to be edited.

See also the following discussion:
https://github.com/netblue30/firejail/discussions/4468
2021-08-25 15:04:17 -03:00
rusty-snake
48b385c0ee
Improve issue template (#4141)
- Avoid confusing on "What changed calling the program by path"
 - Checklist: Questions should be asked in discussions
2021-03-25 16:46:05 +00:00
Fred Barclay
ad0b7fc886 Housekeeping: strip extra whitespace
Just `find . -not \( -name .git -prune -o -name *.AppImage -prune \) -type f -print0 | xargs -0 perl -pi -e 's/ +$//'`
and filter to avoid unwanted changes (especially .md files)
2021-02-08 17:24:28 -06:00
Kelvin M. Klann
2c54e65ab0 bug_report.md: improve wording (upstream/duplicates)
Clarify that:

* "upstream profile" means the profile version on the master branch
* "duplicates" refer to duplicate issues

As suggested by @scruloose on
https://github.com/netblue30/firejail/issues/3884#issue-784605766
https://github.com/netblue30/firejail/issues/3884#issuecomment-759528185
2021-01-14 11:20:30 +00:00
rusty-snake
81bba6c7ee
Update bug_report.md 2020-12-08 09:30:05 +00:00
rusty-snake
f3585e5393 fixes, closes, enhances, improvements, and so on
- .github/ISSUE_TEMPLATE/bug_report.md: get ride off spanish,
   french, ... error messages
 - etc/inc/firefox-common-addons.inc: support ff2mpv
 - etc/profile-a-l/gimp.profile: note about xsane
 - etc/profile-m-z/min.profile: prettify
 - etc/profile-m-z/mpsyt.profile: fix, add lua
 - etc/profile-m-z/qbittorrent.profile: add note for tray-icons; this
   will get a better note once I investigated and audited all the D-Bus
   tray stuff.
 - etc/profile-m-z/transmission-daemon.profile: fix, add protocol packet

close #3686 - mps-youtube needs lua
close #3701 - Firefox native messaging regression in 0.9.62.4 -> 0.9.64rc1
close #3636 - transmission-daemon fills log with error
close #3640 - Gimp - add note how to enable scanning (xsane)
close #3707 - qBittorrent tray icon missing from notification panel when running it with firejail
2020-11-09 20:57:33 +01:00
rusty-snake
eae5d42188
Update bug_report.md
Stop "mentioned"-notes in 1139.
2020-10-20 17:55:39 +00:00
rusty-snake
a0101dbf1d
Update bug_report.md
* Try to make it a bit more friendly for unskilled users.

* Add AppImage --profile hint
2020-09-23 17:43:09 +00:00
Jan
cf81b8e7b6 bug_template: more specific information like related programs, profile existence, lookup for installed profiles and user investigation on related problems 2020-05-04 13:57:51 +02:00
rusty-snake
2bd91a6c9d update issue template + add ICEauthority to wruc 2020-04-21 20:05:49 +02:00
Jan
482e3b100d early decision if git master 2020-04-09 15:12:45 +02:00
Jan
73cb5e1116 request change of behavior description on disabling firejail for specific program 2020-04-09 05:08:35 +02:00
Fred Barclay
bd29bf7202 Add bug report template
(Mostly) auto-generated with GitHub, will need tweaking over time
2020-04-07 16:40:07 -05:00