ceph/src/arrow/go/arrow/internal/debug/doc.go

   1 // Licensed to the Apache Software Foundation (ASF) under one
   2 // or more contributor license agreements.  See the NOTICE file
   3 // distributed with this work for additional information
   4 // regarding copyright ownership.  The ASF licenses this file
   5 // to you under the Apache License, Version 2.0 (the
   6 // "License"); you may not use this file except in compliance
   7 // with the License.  You may obtain a copy of the License at
   8 //
   9 // http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16
  17 /*
  18 Package debug provides APIs for conditional runtime assertions and debug logging.
  19
  20
  21 Using Assert
  22
  23 To enable runtime assertions, build with the assert tag. When the assert tag is omitted,
  24 the code for the assertion will be omitted from the binary.
  25
  26
  27 Using Log
  28
  29 To enable runtime debug logs, build with the debug tag. When the debug tag is omitted,
  30 the code for logging will be omitted from the binary.
  31 */
  32 package debug