Yleiset viestit¶
message( "message text" ...)
Tallentaa määritetyn viestin tekstin lokiin. Jos annetaan useampi kuin yksi viestirivi, ne ketjutetaan yhdeksi viestiksi, jossa merkkijonojen välissä on noseparator.
Vapaaehtoinen <mode>-avainsana määrittää viestin tyypin, joka vaikuttaa tapaan, jolla viestiä käsitellään:
FATAL_ERROR
CMake Error, pysäyttää käsittelyn ja tuottamisen.
SEND_ERROR
CMake Error, jatka käsittelyä, mutta jätä generointi väliin.
WARNING
CMake Warning, jatka käsittelyä.
AUTHOR_WARNING
CMake Warning (dev), jatka käsittelyä.
DEPRECATION
CMake Deprecation Error tai Warning, jos muuttujaCMAKE_ERROR_DEPRECATED tai CMAKE_WARN_DEPRECATEDon vastaavasti käytössä, muuten ei viestiä.
(none) tai NOTICE
Tärkeä viesti tulostetaan stderr:ään käyttäjän huomion herättämiseksi.
STATUS
Pääasialliset mielenkiintoiset viestit, jotka saattavat kiinnostaa projektin käyttäjiä.Ihannetapauksessa näiden tulisi olla lyhyitä, korkeintaan yhden rivin mittaisia, mutta silti informatiivisia.
VERBOSE
Projektin käyttäjille tarkoitetut yksityiskohtaiset informatiiviset viestit. Näissä viesteissäolisi annettava lisätietoja, jotka eivät useimmissa tapauksissa ole kiinnostavia,mutta joista voi olla hyötyä projektin rakentajille, kun he haluavat syvällisempää tietoa siitä, mitä tapahtuu.
DEBUG
Tarkkoja informatiivisia viestejä, jotka on tarkoitettu kehittäjille, jotka työskentelevät itse projektin parissa, toisin kuin käyttäjille, jotka haluavat vain rakentaa sitä. Nämä viestit eivät tyypillisesti kiinnosta muita käyttäjiä, jotka rakentavat projektia, ja ne liittyvät usein läheisesti sisäisiin toteutuksen yksityiskohtiin.
TRACE
Hienojakoiset viestit, jotka sisältävät hyvin matalan tason toteutuksen yksityiskohtia. Tätä lokitasoa käyttävät viestit ovat yleensä vain tilapäisiä ja ne odotetaan poistettavan ennen projektin julkaisemista, tiedostojen pakkaamista jne.
Uutta versiossa 3.15: Lisätty tasot NOTICE, VERBOSE, DEBUG ja TRACE.
CMake-komentorivityökalu näyttää STATUS – TRACE-viestejä komentorivillä STATUS – TRACE stdoutissa, jossa viestiä edeltää kaksi yhdysviivaa ja välilyönti. Kaikki muut viestityypitlähetetään stderr:ään, eikä niiden eteen laiteta väliviivoja. CMake GUI näyttää kaikki viestit lokialueellaan.curses interface näyttää STATUS – TRACEviestit yksitellen tilarivillä ja muut viestit interaktiivisessa ponnahdusikkunassa. Kunkin näistä työkaluista --log-level-komentorivivaihtoehdolla voidaan säätää, mitkä viestit näytetään.
Uutta versiossa 3.17: Jotta lokitaso säilyisi CMake-ajojen välillä, voidaan sen sijaan asettaa muuttuja CMAKE_MESSAGE_LOG_LEVEL.Huomaa, että komentorivivaihtoehto on etusijalla välimuistimuuttujaan nähden.
Uusi versiossa 3.16: Lokitasojen NOTICE ja sitä alempien viestien jokaisen rivin edellä on CMAKE_MESSAGE_INDENT-muuttujan sisältö (muunnettu yhdeksi merkkijonoksi ketjuttamalla sen listan kohteet). STATUS – TRACEviesteissä tämä sisennys lisätään väliviivojen jälkeen.
Uusi versiossa 3.17: Lokitasojen NOTICE ja sitä alempien lokitasojen viestejä voidaan myös edeltää jokaisella rivillä -muotoisella kontekstilla. Sisältö hakasulkeiden välissä saadaan muuntamalla CMAKE_MESSAGE_CONTEXTlist-muuttuja pisteellä erotelluksi merkkijonoksi. Viestin konteksti ilmestyy aina ennen sisennyssisältöä mutta automaattisesti lisättyjen etumerkkien jälkeen. Oletusarvoisesti viestikontekstiä ei näytetä, vaan se on nimenomaisesti otettava käyttöön antamalla cmake --log-contextkomentorivivaihtoehto cmake tai asettamalla CMAKE_MESSAGE_CONTEXT_SHOWmuuttujan arvoksi true. Katso käyttöesimerkkejä CMAKE_MESSAGE_CONTEXTdokumentaatiosta.
CMake varoitus- ja virheviestien tekstin näyttäminen yksinkertaisella merkintäkielellä. Teksti, jossa ei ole sisennyksiä, muotoillaan rivinvaihdetuiksi kappaleiksi, jotka on erotettu rivinvaihtoviivoilla. Sisennetty teksti katsotaan valmiiksi muotoilluksi.