Skip to content

Commit

Permalink
fix: Global flock fallback to single-user mode if insufficient permis…
Browse files Browse the repository at this point in the history 
…sions (#1743, #1751)

The global flock context manager (introduced in #1679) now fall back to single-user mode if permissions are insufficient to create an flock file accessible by other users and root. The multi-user mode will be activate later and automatically when BIT is started as root for the first time. It will create an flock file accessible by all users.

That behavior is relevant for Arch-based systems but not relevant on Debian-based systems because regular users have enough permissions to /run/lock.

Additionally fix a bug (introduced with #1679) ignoring the config value of `global.use_flock`.

Additionally Sphinx config is modified and improved..

Fix #1743 
Fix #1751
  • Loading branch information
@buhtz
buhtz committed Jul 6, 2024
1 parent 7e98c0f commit ba50bf9
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 214 deletions.
1 change: 1 addition & 0 deletions CHANGES
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Back In Time

Version 1.4.4-dev (development of upcoming release)
* Fix: Global flock fallback to single-user mode if insufficient permissions (#1743, #1751)
* Chore!: Remove "debian" folder (#1548)
* Breaking Change: EncFS deprecation warning (#1735, #1734)
* Fix: Fix Qt segmentation fault with uninstall ExtraMouseButtonEventFilter when closing main window (#1095)
Expand Down
2 changes: 2 additions & 0 deletions TRANSLATIONS
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Bokmål (Norwegian) [nb_NO]: Hans Fredrik Nordhaug <hansfn@gmail.com>
Catalan [ca]: Josep Sanchez <papapep@gmail.com>
Chinese (Simplified) [zh_CN,zh_Hans]: Kuntao Zhao <kt.zhao@gmail.com>
Chinese (Traditional) [zh_TW,zh_Hant]: Kuntao Zhao <kt.zhao@gmail.com>
Danish [da]: Adam Sjøgren <asjo@koldfront.dk>
German [de]: Michael Wiedmann <mw@miwie.in-berlin.de>
Greek [el]: Iliana Panagopoulou (hpanago)
French [fr]: Michel Corps <mahikeulbody@gmail.com>, jej@github
Indonesian [id]: Andika Triwidada <andika@gmail.com>
Japanese [ja]:
Expand Down
171 changes: 9 additions & 162 deletions common/doc-dev/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,4 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# BackInTime documentation build configuration file, created by
# sphinx-quickstart on Sat Jan 9 00:04:35 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

Expand All @@ -24,17 +10,11 @@
sys.path.insert(0, os.path.abspath(os.path.join(os.pardir)))
sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, "plugins")))

#import config to solve race conditions between config an mount
# Import to solve race conditions between config an mount.
import config

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
Expand All @@ -49,9 +29,6 @@
# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

Expand All @@ -66,43 +43,21 @@
# The full version, including alpha/beta/rc tags.
release = version # '1.3.3-dev'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
autodoc_default_options = {
'members': True,
'member-order': 'bysource',
'private-members': True,
'undoc-members': True,
'special-members': True,
'exclude-members': '__weakref__,__dict__,__module__,__annotations__',
}

# -- Intersphinx options --------------------------------------------------

Expand All @@ -113,95 +68,26 @@
}

# -- Napoleon include private members which have docstrings ---------------

napoleon_include_private_with_doc = True

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'classic'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y, %H:%M (%Z)'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'BackInTimeDevDoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
Expand All @@ -223,27 +109,6 @@
'Germar Reitze', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
Expand All @@ -253,10 +118,6 @@
['Germar Reitze'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
Expand All @@ -267,17 +128,3 @@
'Germar Reitze', 'BackInTime', 'One line description of project.',
'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Loading

0 comments on commit ba50bf9

Please sign in to comment.