ad_log_deprecated (public)

 ad_log_deprecated what oldCmd [ newCmd ]

Defined in packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl

Provide a standardized interface for reporting deprecated ad_procs or other artifacts. In some situations, the flag "-deprecated" in the proc is not sufficient. When "newCmd" is not specified, this function tries to get the replacement command from the @see specification of the documentation.

Parameters:
what - type of artifact being used (e.g. "proc" or "class")
oldCmd - the name of the deprecated command
newCmd (optional) - replacement command, when specified

Partial Call Graph (max 5 caller/called nodes):
%3 Se Se (public, deprecated) ad_log_deprecated ad_log_deprecated Se->ad_log_deprecated _mr _mr (private, deprecated) _mr->ad_log_deprecated aa_example_write_audit_entries aa_example_write_audit_entries (public, deprecated) aa_example_write_audit_entries->ad_log_deprecated aa_example_write_audit_entry aa_example_write_audit_entry (private, deprecated) aa_example_write_audit_entry->ad_log_deprecated acs_lookup_magic_object acs_lookup_magic_object (private, deprecated) acs_lookup_magic_object->ad_log_deprecated

Testcases:
No testcase defined.
Source code:
    set msg "*** $what $oldCmd is deprecated."
    if {$newCmd eq "" && $what eq "proc"} {
        #
        # If no replacement command is provided, use whatever is
        # specified in the @see property of the definition.
        #
        # The "oldCmd" should be fully qualified but with no leading
        # colons, like "template::util::date::now_min_interval_plus_hour"
        #
        if {[nsv_get api_proc_doc $oldCmd dict]
            && [dict exists $dict see]
        } {
            set newCmd [dict get $dict see]
        }
    }
    if {$newCmd ne ""} {
        append msg " Use '$newCmd' instead."
    }      
    ns_log warning "$msg\n[uplevel ad_get_tcl_call_stack]"
XQL Not present:
Generic, PostgreSQL, Oracle
[ hide source ] | [ make this the default ]
Show another procedure: