From fdb60f5b2da69c5a725fc8f47fbed9cfd56624d1 Mon Sep 17 00:00:00 2001 From: Jeff Mitchell Date: Wed, 7 Sep 2022 16:44:23 -0400 Subject: [PATCH] Update comment around undocumented config flag --- internal/cmd/config/config.go | 4 +++- internal/cmd/config/config_test.go | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/internal/cmd/config/config.go b/internal/cmd/config/config.go index 046507f793..3152b7f667 100644 --- a/internal/cmd/config/config.go +++ b/internal/cmd/config/config.go @@ -230,7 +230,9 @@ type Database struct { ConnMaxIdleTimeDuration *time.Duration `hcl:"-"` // SkipSharedLockAcquisition allows skipping grabbing the database shared - // lock. This is dangerous unless you know what you're doing. + // lock. This is dangerous unless you know what you're doing, and you should + // not set it unless you are the reason it's here in the first place, as not + // only it dangerous but it will be removed at some point in the future. SkipSharedLockAcquisition bool `hcl:"skip_shared_lock_acquisition"` } diff --git a/internal/cmd/config/config_test.go b/internal/cmd/config/config_test.go index e2ba32f251..90d272898b 100644 --- a/internal/cmd/config/config_test.go +++ b/internal/cmd/config/config_test.go @@ -1722,7 +1722,7 @@ func TestDatabaseSkipSharedLockAcquisition(t *testing.T) { require.NotNil(t, c) require.NotNil(t, c.Controller) require.NotNil(t, c.Controller.Database) - require.Equal(t, tt.expSkipSharedLockAcquisition, *&c.Controller.Database.SkipSharedLockAcquisition) + require.Equal(t, tt.expSkipSharedLockAcquisition, c.Controller.Database.SkipSharedLockAcquisition) }) } }