From bc2f844f3b54addede82627be798124043c3e955 Mon Sep 17 00:00:00 2001
From: Eileen <eileen@fuzion.co.nz>
Date: Thu, 17 Oct 2013 11:51:19 +1300
Subject: [PATCH] CRM-13598 d6 user vaauthentication - add comments

----------------------------------------
* CRM-13598: User drupal {users} rather than storing name of drupal user table
  http://issues.civicrm.org/jira/browse/CRM-13598
---
 CRM/Utils/System/Drupal6.php | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php
index b544245b1d..2a504269c5 100644
--- a/CRM/Utils/System/Drupal6.php
+++ b/CRM/Utils/System/Drupal6.php
@@ -528,6 +528,13 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase {
    * @access public
    */
   function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
+   //@todo this 'PEAR-y' stuff is only required when bookstrap is not being loaded which is rare
+   // if ever now.
+   // probably if bootstrap is loaded this call
+   // CRM_Utils_System::loadBootStrap($bootStrapParams, TRUE, TRUE, $realPath); would be
+   // sufficient to do what this fn does. It does exist as opposed to return which might need some hanky-panky to make
+   // safe in the unknown situation where authenticate might be called & it is important that
+   // false is returned
     require_once 'DB.php';
 
     $config = CRM_Core_Config::singleton();
-- 
2.25.1