Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not monitor remote/network directories by default in browser, allow users to opt-in to this #43416

Merged
merged 4 commits into from
May 31, 2021

Conversation

nyalldawson
Copy link
Collaborator

This PR changes the logic used to determine whether a directory item in the browser panel will be automatically monitored for changes. This automatic monitoring is expensive to do in some circumstances (e.g. for network drives or cloud based drives), and has been a cause of long reported hangs in the QGIS interface.

Now:

  • We no longer automatically monitor directories which reside on a remote or network drive (on Windows)
  • The context menu shown when right clicking a directory in browser has a new option "Monitor for Changes", which allows users to manually control whether a particular directory should be monitored. This setting applies to the selected directory and all subdirectories. So users can manually opt-in to monitoring of network drives if they know there's no issue, OR manually opt-out of monitoring of large directories which they don't want monitored for other reasons.

Together these changes should help improve QGIS responsiveness when used in remote/work-from-home environments.

items should be automatically monitored for changes

This monitoring can be expensive for some locations (eg network
folders or cloud based directories), so in these cases it is
desirable to allow it to be disabled to avoid hangs in the QGIS
application.
to allow users to explicit control whether a directory is
automatically monitored for changes.
are slow

Effectively this means that the browser no longer defaults to watching
network and remote drives (on Windows) for changes. This is expensive
to do and can result in large hangs in the QGIS application.

Users can still manually opt-in to monitoring of these locations
through the context menu of the directory in the browser panel.
@nyalldawson nyalldawson added QGIS Browser Needs Documentation When merging a labeled PR, an issue will be created in the Doc repo. labels May 27, 2021
@github-actions
Copy link

@nyalldawson
This pull request has been tagged as requiring documentation.

A documentation ticket will be opened at https://github.com/qgis/QGIS-Documentation when this PR is merged.

Please update the description (not the comments) with helpful description and screenshot to help the work from documentors.
Also, any commit having [needs-doc] or [Needs Documentation] in will see its message pushed to the issue, so please be as verbose as you can.

Thank you!

@github-actions github-actions bot added this to the 3.20.0 milestone May 27, 2021
@nyalldawson
Copy link
Collaborator Author

Any takers for a review here?

Copy link
Contributor

@nirvn nirvn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's great stuff, glad this is being addressed. I'm no windows users, but I recon this'll make quite a few people very happy.

@github-actions
Copy link

@nyalldawson
A documentation ticket has been opened at qgis/QGIS-Documentation#6731
It is your responsibility to visit this ticket and add as much detail as possible for the documentation team to correctly document this change.
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Documentation When merging a labeled PR, an issue will be created in the Doc repo. QGIS Browser
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants