Documentation change only: explain why we do a check.

RobMeades · RobMeades · commit b747695052aa · 2024-03-06T10:52:05.000Z
diff --git a/common/security/src/u_security_tls.c b/common/security/src/u_security_tls.c
@@ -175,6 +175,8 @@ uSecurityTlsContext_t *pUSecurityTlsAdd(uDeviceHandle_t devHandle,
                 }
             } else if (devType == (int32_t) U_DEVICE_TYPE_CELL) {
                 errorCode = (int32_t) U_ERROR_COMMON_TOO_BIG;
+                // Make sure that the number of cipher suites selected is
+                // supported by the cellular module we are using
                 if ((pSettings == NULL) ||
                     (pSettings->cipherSuites.num <= 1) ||
                     uCellSecTlsCipherSuiteMoreThanOne(devHandle)) {

Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,8 @@ uSecurityTlsContext_t *pUSecurityTlsAdd(uDeviceHandle_t devHandle,`
`175`	`175`	`}`
`176`	`176`	`} else if (devType == (int32_t) U_DEVICE_TYPE_CELL) {`
`177`	`177`	`errorCode = (int32_t) U_ERROR_COMMON_TOO_BIG;`
	`178`	`+ // Make sure that the number of cipher suites selected is`
	`179`	`+ // supported by the cellular module we are using`
`178`	`180`	`if ((pSettings == NULL) \|\|`
`179`	`181`	`(pSettings->cipherSuites.num <= 1) \|\|`
`180`	`182`	`uCellSecTlsCipherSuiteMoreThanOne(devHandle)) {`