vcs: clarify read action requirement in file dirty API

If the read action is needed (e.g., to avoid deadlock with inner lock) - the method should take it itself but not just because of API requirement.

GitOrigin-RevId: 481d139fedd59dfd1d58b3a3fb9405d58c879685
This commit is contained in:
Dmitry Zhuravlev
2024-11-14 16:04:28 +00:00
committed by intellij-monorepo-bot
parent fe989c63f0
commit d4d49131dd
@@ -1,4 +1,4 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.openapi.vcs.changes;
import com.intellij.openapi.project.Project;
@@ -26,14 +26,14 @@ public abstract class VcsDirtyScopeManager {
public abstract void markEverythingDirty();
/**
* Requests an asynchronous file status update for the specified virtual file. Must be called from a read action.
* Requests an asynchronous file status update for the specified virtual file.
*
* @param file the file for which the status update is requested.
*/
public abstract void fileDirty(@NotNull VirtualFile file);
/**
* Requests an asynchronous file status update for the specified file path. Must be called from a read action.
* Requests an asynchronous file status update for the specified file path.
*
* @param file the file path for which the status update is requested.
*/