Explain that `limit` only applies to the check

diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 71d46d4..71cbd07 100644 (file)
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -116,8 +116,8 @@ production: &base
   # ==========================
 
   ## LDAP settings
-  # You can inspect the first 100 LDAP users with login access by running:
-  #   bundle exec rake gitlab:ldap:check[100] RAILS_ENV=production
+  # You can inspect a sample of the LDAP users with login access by running:
+  #   bundle exec rake gitlab:ldap:check RAILS_ENV=production
   ldap:
     enabled: false
     host: '_your_ldap_server'

diff --git a/lib/tasks/gitlab/check.rake b/lib/tasks/gitlab/check.rake
index 20d5f03..461e70e 100644 (file)
--- a/lib/tasks/gitlab/check.rake
+++ b/lib/tasks/gitlab/check.rake
@@ -682,6 +682,8 @@ namespace :gitlab do
 
   namespace :ldap do
     task :check, [:limit] => :environment do |t, args|
+      # Only show up to 100 results because LDAP directories can be very big.
+      # This setting only affects the `rake gitlab:check` script.
       args.with_defaults(limit: 100)
       warn_user_is_not_gitlab
       start_checking "LDAP"